Users

Retrieve information about the user authenticated by the current personal access token.

Get an account

get

Retrieve an account with its plan and current-period usage. Use it to watch screenshot consumption against the plan before it runs over.

Authorizations

personalAccessTokenoauth2

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

accountSlugstring · min: 1Required

Slug of the account to retrieve.

Responses

200

The account with its plan and usage

application/json

An account with its plan and current-period usage, to watch consumption against the plan.

idstringRequired

slugstring · min: 1Required

namestring · nullableRequired

typestring · enumRequiredPossible values:

periodStartDatestring · date-time · nullableRequired

Start of the current billing period.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

periodEndDatestring · date-time · nullableRequired

End of the current billing period.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

currentPeriodScreenshotsinteger · min: -9007199254740991 · max: 9007199254740991Required

Screenshots used since the start of the current period.

includedScreenshotsinteger · min: -9007199254740991 · max: 9007199254740991Required

Screenshots included in the plan for a period.

consumptionRationumberRequired

Used screenshots over included screenshots. Above 1 the account is over its plan and pays for the extra.

additionalScreenshotsCostnumberRequired

Cost accrued so far this period for screenshots beyond the plan, in the subscription's currency.

defaultUserLevelstring · enum · nullableRequired

Role given to users joining through the invite link or a verified domain. null on a personal account.

Possible values:

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

get/accounts/{accountSlug}

HTTPcURLJavaScriptPython

GET /v2/accounts/{accountSlug} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "slug": "text",
  "name": "text",
  "type": "user",
  "plan": {
    "name": "text",
    "includedScreenshots": 1
  },
  "periodStartDate": "2026-08-09T20:56:11.953Z",
  "periodEndDate": "2026-08-09T20:56:11.953Z",
  "currentPeriodScreenshots": 1,
  "includedScreenshots": 1,
  "consumptionRatio": 1,
  "additionalScreenshotsCost": 1,
  "defaultUserLevel": "member"
}

Get the current user

get

Retrieve the user associated with the token used to authenticate the request, with the accounts (personal and teams) the token can access. Account slugs are the owner used in other API paths.

Authorizations

personalAccessTokenoauth2

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Responses

200

The authenticated user

application/json

The authenticated user.

idstringRequired

slugstringRequired

namestring · nullableRequired

401

Unauthorized

application/json

500

Server error

application/json

get/me

HTTPcURLJavaScriptPython

GET /v2/me HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "slug": "text",
  "name": "text",
  "accounts": [
    {
      "id": "text",
      "slug": "text",
      "name": "text",
      "type": "user"
    }
  ]
}