Sign in

v1

latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB
Deprecated End Points

Create an API user

Create an API user

post/v3/api_users

Request body

namestring
usernamestring
emailstring
avatarstring nullable

URL of the user's avatar.

organizationstring required

Uniquely identify an organization.

Example request

{
  "name": "Carl Johnson",
  "username": "carljohnson",
  "email": "carljohnson@grove.street",
  "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
  "organization": "mEFayXdO"
}

Response

Successfully created an API user. The API key is shown once in this response and will not be shown again in subsequent retrieval requests."

idinteger required

Uniquely identify a user.

namestring required
usernamestring required
emailstring required
avatarstring nullable required

URL of the user's avatar.

apiKeystring required

Use this key to authenticate with the API.

apiKeyLastCharsstring

The last 4 characters of the API key.

Example response

{
  "id": 1,
  "name": "Carl Johnson",
  "username": "carljohnson",
  "email": "carljohnson@grove.street",
  "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
  "organizations": [
    {
      "identifier": "mEFayXdO",
      "name": "Grove Street King"
    }
  ]
}