Query for admin workers

GET 
/api/v3/admin

Valid query parameters:

• admin_id
• external_key
• email
• first_name
• last_name

Request

Query Parameters

where string

first_name:EQUALS:jane

order string

admin_id:ASC

limit string

2

offset string

8

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

admin_id integer

Admin ID #

username string

Username

external_key string

External key value

timezone string

Timezone

name string

Full name

first_name string

First Name

last_name string

Last Name

initials string

Initials

nickname string

Nickname

email string

Email address

twitter string

Twitter URL

facebook string

Facebook URL

linkedin string

LinkedIn URL

login_count string

The # of times the worker has logged in

login_datetime string

Last logged in

custom_1 string

Custom field value #1

custom_2 string

Custom field value #2

custom_3 string

Custom field value #3

custom_4 string

Custom field value #4

custom_5 string

Custom field value #5

write_datetime date

Date/time the admin was created

mod_datetime date

Date/time the admin was modified

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "admin_id": 0,
      "username": "string",
      "external_key": "string",
      "timezone": "string",
      "name": "string",
      "first_name": "string",
      "last_name": "string",
      "initials": "string",
      "nickname": "string",
      "email": "string",
      "twitter": "string",
      "facebook": "string",
      "linkedin": "string",
      "login_count": "string",
      "login_datetime": "string",
      "custom_1": "string",
      "custom_2": "string",
      "custom_3": "string",
      "custom_4": "string",
      "custom_5": "string",
      "write_datetime": "2024-07-29",
      "mod_datetime": "2024-07-29"
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "admin_id": 10,
      "external_key": null,
      "timezone": "America/Detroit",
      "first_name": "Keith",
      "last_name": "Palmer",
      "initials": null,
      "email": "noreply@chargeover.com",
      "login_datetime": "2015-03-03 22:04:38",
      "write_datetime": "2015-03-03 22:02:37",
      "mod_datetime": "2015-03-03 22:04:36",
      "name": "Keith Palmer",
      "username": "noreply@chargeover.com"
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...