Skip to content

Latest commit

 

History

History
53 lines (43 loc) · 996 Bytes

profiles.md

File metadata and controls

53 lines (43 loc) · 996 Bytes
Raw

Profiles

Get company profiles

  • GET v1/profiles - Returns all company profiles.
Response fields Description/format
id Integer
name String
can_be_edited Boolean
person_count Integer, number of people that that have this profile
profile_permission List

Sample JSON response

[
   {
      "id":1,
      "name":"Collaborator",
      "can_be_edited":true,
      "person_count":2,
      "profile_permission":[],
   }, ...
]

Get person profiles

  • GET v1/profiles/person/{person_id} - Returns all person profiles.
Response fields Description/format
id Integer
name String
can_be_edited Boolean
person_count Integer, number of people that that have this profile
profile_permission List

Sample JSON response

[
   {
      "id":1,
      "name":"Collaborator",
      "can_be_edited":true,
      "person_count":2,
      "profile_permission":[],
   }, ...
]