List by groups - PERSCOM Documentation

List by groups

curl --request GET \
  --url https://api.perscom.io/{version}/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": "<string>",
              "profile_photo_url": "<string>",
              "cover_photo": "<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
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 123
  }
}

GET

{version}

roster

List by groups

curl --request GET \
  --url https://api.perscom.io/{version}/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": "<string>",
              "profile_photo_url": "<string>",
              "cover_photo": "<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
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "last_page": 123,
    "path": "<string>",
    "per_page": 123,
    "to": 123,
    "total": 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

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

data

RosterResource · object[]

Show child attributes

data.name

string

required

data.description

string | null

Supports HTML.

data.order

integer

Will be auto-calculated if nothing is provided.

data.hidden

boolean

default:false

data.icon

string | null

A valid Heroicon.

data.image

Image · object

Show child attributes

data.image.name

string

required

The name of the image.

Maximum string length: 255

data.image.description

string | null

A description of the image. Supports HTML.

Maximum string length: 65535

data.image.filename

string

The original filename of the uploaded image.

Maximum string length: 255

data.image.path

string

The storage path of the uploaded image.

Maximum string length: 255

data.image.image_url

string

The URL to access the image.

data.units

RosterUnit · object[]

Show child attributes

data.units.name

string

required

data.units.description

string | null

Supports HTML.

data.units.order

integer

Will be auto-calculated if nothing is provided.

data.units.hidden

boolean

default:false

data.units.icon

string | null

A valid Heroicon.

data.units.image

Image · object

Show child attributes

data.units.image.name

string

required

The name of the image.

Maximum string length: 255

data.units.image.description

string | null

A description of the image. Supports HTML.

Maximum string length: 65535

data.units.image.filename

string

The original filename of the uploaded image.

Maximum string length: 255

data.units.image.path

string

The storage path of the uploaded image.

Maximum string length: 255

data.units.image.image_url

string

The URL to access the image.

data.units.users

User · object[]

Show child attributes

data.units.users.name

string

required

data.units.users.email

string

required

data.units.users.email_verified_at

string<date-time> | null

data.units.users.phone_number

string | null

data.units.users.position_id

integer | null

data.units.users.rank_id

integer | null

data.units.users.specialty_id

integer | null

data.units.users.status_id

integer | null

data.units.users.unit_id

integer | null

data.units.users.approved

boolean

default:true

data.units.users.online

boolean

data.units.users.notes

string | null

Supports HTML.

data.units.users.notes_updated_at

string<date-time> | null

data.units.users.profile_photo

file | null

data.units.users.profile_photo_url

string | null

data.units.users.cover_photo

file | null

data.units.users.cover_photo_url

string | null

data.units.users.discord_user_id

string | null

data.units.users.timezone

string | null

data.units.users.last_seen_at

string<date-time> | null

data.units.users.last_assignment_change_date

string<date-time> | null

data.units.users.last_rank_change_date

string<date-time> | null

data.id

integer

links

ResourceLinks · object

Show child attributes

links.first

string<uri>

links.last

string<uri>

links.prev

string<uri>

links.next

string<uri>

API Reference

Authorizations

Path Parameters

Query Parameters

Response