Skip to main content
GET
/
projects
/
{projectId}
/
users
/
List users
curl --request GET \
  --url https://spectrum.photon.codes/projects/{projectId}/users/
{
  "succeed": true,
  "data": {
    "users": [
      {
        "id": "<string>",
        "projectId": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phoneNumber": "<string>",
        "assignedPhoneNumber": "<string>",
        "meta": {},
        "createdAt": "<string>"
      }
    ],
    "total": 0
  }
}

Path Parameters

projectId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

type
enum<string>
Available options:
shared,
dedicated
id
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Minimum string length: 1
limit
integer
Required range: 1 <= x <= 500
offset
integer
Required range: 0 <= x <= 1000000

Response

200 - application/json

Response for status 200

succeed
boolean
required
data
object
required