Groups

GET /2023-03-01/xhr/groups

The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- id string | null Required
- remote_id string | null Required
- name string | null Required
- type string | null Required
  
  Values are null, department, team, cost_centre, or pay_group.
202 application/json

Accepted + pending (async job started)
Hide headers attribute Show headers attribute
- Retry-After integer
  
  Retry your call after the specified amount of seconds
Hide response attribute Show response attribute object
- message string Required
401 application/json

Authentication Error
Hide response attributes Show response attributes object
- error string Required
  
  The type of error
  
  Value is authentication_error.
- message string Required
  
  A descriptive description of the error
- code string Required
  
  Values are incorrect_username_or_password, incorrect_mfa_or_otp, reauthentication_required // cookies are now expired, additional_account_setup_required // password reset, etc, captcha_challenge // amazon type1 captcha challenge (currently unsovable), no_valid_accounts // not used currently but reserved for future use, or insufficient_permission // not enough privileges (ie not an admin, or not enough provider scopes on a provider api token for the Affix scopes requested).
429 application/json

Rate Limited / Too Many Requests
Hide headers attribute Show headers attribute
- Retry-After integer
  
  Retry your call after the specified amount of seconds
Hide response attribute Show response attribute object
- message string Required
500 application/json

Server Error
Hide response attribute Show response attribute object
- message string Required
501 application/json

Not Implemented
Hide response attribute Show response attribute object
- message string Required

GET /2023-03-01/xhr/groups

curl \
 -X GET https://api.affixapi.com/2023-03-01/xhr/groups \
 -H "Authorization: $API_KEY"

Response examples (200)

[
  {
    "id": "4B9bKBpX5tnwjiG93TAqF7ci",
    "name": "backend",
    "type": "team",
    "remote_id": "df6c28e8"
  },
  {
    "id": "132Xpnw2a38aaQG93TAqF7ci",
    "name": "engineering",
    "type": "department",
    "remote_id": "355c65922637"
  }
]

Response examples (202)

# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}

Response examples (401)

{
  "error": "authentication_error",
  "message": "Your password is incorrect",
  "code": "incorrect_username_or_password"
}

Response examples (429)

# Headers
Retry-After: 42

# Payload
{
  "message": "string"
}

Response examples (500)

{
  "message": "string"
}

Response examples (501)

{
  "message": "string"
}