Skip to main content

Client account

Your client account is the container for everything you do with Paylode — your team, your API key, your branding, and your access settings all live under it.

When you sign on with Paylode, we provision a client account for your company and seed it with your first user. From there the account holds:

  • Your users — the people on your team who can sign in and manage the account. Today every user is a full administrator (see the note below).
  • One API key — the credential your integration uses to call the API. It's issued per account and scopes every response to your own data. See API key.
  • Your identity and branding — your company name, a URL-friendly slug, your industry classification, and the logos that appear on your hosted and embedded perks surfaces.
  • Your access controls — IP whitelists that govern who can sign in and which sensitive operations are allowed from where. See Restrict access by IP.

Most of these you manage yourself in the Paylode app; a few — creating the account itself and seeding the first user — are done for you when you're onboarded.

How it works​

The account is the tenancy boundary. Everything you create — perk collections, Boost campaigns, reports — belongs to your account, and every API call is authenticated by your API key, which determines the account you're authorized to act on. Account-scoped endpoints still carry your account id in the path (as in the examples below); the key is what ties that id to you.

Your account carries a small set of stable properties:

PropertyWhat it is
nameYour company's display name.
slugA URL-friendly identifier for your account (e.g. example-co).
clientDomainThe domain used for your hosted perks surfaces.
industriesYour industry classification, used for catalog relevance.
typesThe account's role in the platform.
rectangularLogo / squareLogoYour branding, shown on perks surfaces.
isActiveWhether the account is currently active.
note

Team members currently have no distinct roles — every user on an account is an administrator with the same permissions. There's no viewer-only or billing-only role today. If a finer-grained permission model matters to you, raise it with your Paylode contact so it can be weighed for the roadmap.

In the API​

You can read your own account details with getClient. Authenticate with your API key (see Authentication); the id in the path is your own account id.

curl https://client.paylode.com/client/13 \
  -H "X-API-Key: 6341c870-c23a-11ec-a6d6-0800200c9a66"

A trimmed response:

{
  "id": 13,
  "slug": "example-co",
  "name": "Example Co",
  "clientDomain": "example.com",
  "isActive": true,
  "industries": [ { "id": 5, "name": "Retail" } ],
  "types": [ "CLIENT" ]
}

The full schema — every field, plus the team, profile, and settings operations — is on developers.paylode.com.