GET
/
{version}
/
roster
/
{roster}
curl --request GET \
  --url https://api.perscom.io/{version}/roster/{roster} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "name": "<string>",
    "description": "<string>",
    "order": 123,
    "hidden": false,
    "icon": "<string>",
    "image": {
      "name": "<string>",
      "description": "<string>",
      "filename": "<string>",
      "path": "<string>",
      "image_url": "<string>"
    },
    "units": [
      {
        "name": "<string>",
        "description": "<string>",
        "order": 123,
        "hidden": false,
        "icon": "<string>",
        "image": {
          "name": "<string>",
          "description": "<string>",
          "filename": "<string>",
          "path": "<string>",
          "image_url": "<string>"
        },
        "users": [
          {
            "name": "<string>",
            "email": "<string>",
            "email_verified_at": "2023-11-07T05:31:56Z",
            "phone_number": "<string>",
            "position_id": 123,
            "rank_id": 123,
            "specialty_id": 123,
            "status_id": 123,
            "unit_id": 123,
            "approved": true,
            "online": true,
            "notes": "<string>",
            "notes_updated_at": "2023-11-07T05:31:56Z",
            "profile_photo_url": "<string>",
            "cover_photo_url": "<string>",
            "discord_user_id": "<string>",
            "timezone": "<string>",
            "last_seen_at": "2023-11-07T05:31:56Z",
            "last_assignment_change_date": "2023-11-07T05:31:56Z",
            "last_rank_change_date": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ],
    "id": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2
​
roster
integer
required

Query Parameters

​
include
enum<string>
Available options:
image,
units,
units.image,
units.users,
units.users.position,
units.users.rank,
units.users.rank.image,
units.users.specialty,
units.users.status,
units.*

Response

200
application/json
OK
​
data
object

Was this page helpful?

List by groupsGet a list of settings