Members
Manage who is on a team and what they can reach: list members, change their role, remove them, and send or cancel invitations.
Change the role given to users that join a team through its invite link or a verified email domain. Requires administrator access to the team.
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.
Slug of the team.
Role given to users that join a team through its invite link or a verified email domain.
The updated account
An account with its plan and current-period usage, to watch consumption against the plan.
Start of the current billing period.
^(?:(?:\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))$End of the current billing period.
^(?:(?:\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))$Screenshots used since the start of the current period.
Screenshots included in the plan for a period.
Used screenshots over included screenshots. Above 1 the account is over its plan and pays for the extra.
Cost accrued so far this period for screenshots beyond the plan, in the subscription's currency.
Role given to users joining through the invite link or a verified domain. null on a personal account.
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
PATCH /v2/accounts/{accountSlug} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"defaultUserLevel": "member"
}{
"id": "text",
"slug": "text",
"name": null,
"type": "user",
"plan": {
"name": "text",
"includedScreenshots": 1
},
"periodStartDate": "2026-01-01T00:00:00.000Z",
"periodEndDate": "2026-01-01T00:00:00.000Z",
"currentPeriodScreenshots": 1,
"includedScreenshots": 1,
"consumptionRatio": 1,
"additionalScreenshotsCost": 1,
"defaultUserLevel": "member"
}List the members of a team, with their role. Requires administrator access to the team.
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.
Slug of the team to list members for.
Number of items per page (max 100)
Page number
Match members on their name, slug, or email address.
Restrict to the given roles, comma-separated (e.g. owner,member).
Ordering of the results. Defaults to date, most recently added first.
List of team members
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
GET /v2/accounts/{accountSlug}/members HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pageInfo": {
"total": 1,
"page": 1,
"perPage": 1
},
"results": [
{
"id": "text",
"user": {
"id": "text",
"slug": "text",
"name": null
},
"level": "owner"
}
]
}Remove a user from a team. Requires administrator access to the team. The last member of a team cannot be removed; removing the second-to-last one promotes the remaining member to owner.
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.
Slug of the team.
Identifier of the user to act on — the user.id returned by listAccountMembers, which is the user's account id.
Member removed
No content
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
DELETE /v2/accounts/{accountSlug}/members/{userId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Change the role of an existing team member. Requires administrator access to the team.
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.
Slug of the team.
Identifier of the user to act on — the user.id returned by listAccountMembers, which is the user's account id.
Role of a user on a team. Owners administer the team, members see every project, contributors only the projects they are added to.
The updated membership
A member of a team.
Identifier of the membership, not of the user.
Role of a user on a team. Owners administer the team, members see every project, contributors only the projects they are added to.
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
PATCH /v2/accounts/{accountSlug}/members/{userId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"level": "owner"
}{
"id": "text",
"user": {
"id": "text",
"slug": "text",
"name": null
},
"level": "owner"
}List the pending invitations to join a team, most recent first. Requires administrator access to the team.
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.
Slug of the team.
Number of items per page (max 100)
Page number
Match invites on their email address.
List of pending invites
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
GET /v2/accounts/{accountSlug}/invites HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pageInfo": {
"total": 1,
"page": 1,
"perPage": 1
},
"results": [
{
"id": "text",
"email": "name@gmail.com",
"level": "owner",
"createdAt": "2026-01-01T00:00:00.000Z",
"expiresAt": "2026-01-01T00:00:00.000Z",
"expired": true
}
]
}Invite people to a team by email. Each invited address receives an email with a link to join. Re-inviting an address that already has a pending invite refreshes it. Requires administrator access to the team.
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.
Slug of the team.
The invites that were created
A pending invitation to join a team.
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Role of a user on a team. Owners administer the team, members see every project, contributors only the projects they are added to.
^(?:(?:\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))$^(?:(?:\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))$Whether the invite is past its expiry date. Expired invites stay listed until they are cancelled or re-sent.
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
POST /v2/accounts/{accountSlug}/invites HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"members": [
{
"email": "name@gmail.com",
"level": "owner"
}
]
}[
{
"id": "text",
"email": "name@gmail.com",
"level": "owner",
"createdAt": "2026-01-01T00:00:00.000Z",
"expiresAt": "2026-01-01T00:00:00.000Z",
"expired": true
}
]Cancel a pending invitation, invalidating its link. Requires administrator access to the team.
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.
Slug of the team.
Identifier of the invite, as returned when listing them.
Invite cancelled
No content
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
DELETE /v2/accounts/{accountSlug}/invites/{inviteId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
List the email domains a team is open to. Requires administrator access to the team.
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.
Slug of the team.
The team's email domains
An email domain the team is open to: anyone signing up with a verified address on it joins automatically, at the team's default role.
^(?:(?:\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))$Invalid parameters
Unauthorized
Forbidden
Not found
Server error
GET /v2/accounts/{accountSlug}/domains HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"domain": "text",
"createdAt": "2026-01-01T00:00:00.000Z"
}
]Add an email domain to a team, so anyone signing up with a verified address on it joins automatically. Requires administrator access to the team, and you must yourself hold a verified address on the domain — a team can only be opened to a domain its administrator demonstrably belongs to. Public email providers are refused.
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.
Slug of the team.
The email domain, e.g. acme.com.
The domain the team is now open to
An email domain the team is open to: anyone signing up with a verified address on it joins automatically, at the team's default role.
^(?:(?:\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))$Invalid parameters
Unauthorized
Forbidden
Not found
Server error
POST /v2/accounts/{accountSlug}/domains HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"domain": "text"
}{
"domain": "text",
"createdAt": "2026-01-01T00:00:00.000Z"
}Remove an email domain from a team. New sign-ups on it no longer join automatically; members who already joined stay. Requires administrator access to the team.
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.
Slug of the team.
The email domain to remove.
Domain removed
No content
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
DELETE /v2/accounts/{accountSlug}/domains/{domain} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Rotate the team's shared invite link, invalidating the previous one. Anyone holding the old link can no longer use it to join. Requires administrator access to the team.
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.
Slug of the team.
The new invite link
The team's new shared invite link. Anyone with it joins at the team's default role.
Invalid parameters
Unauthorized
Forbidden
Not found
Server error
POST /v2/accounts/{accountSlug}/invite-link/reset HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"inviteLink": "https://example.com"
}Last updated
Was this helpful?