# Roles ## GET /roles/ > ```json {"openapi":"3.0.1","info":{"title":"Relabase Public API","version":"v1"},"servers":[{"url":"api.rekap.com/relabase/api/v1/public"}],"security":[{"Bearer":[]},{"Token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Authenticate using `Bearer ` format for internal endpoints","name":"Authorization","in":"header"},"Token":{"type":"apiKey","description":"Authenticate using `Token ` format","name":"Authorization","in":"header"}},"schemas":{"PublicRoleSummary":{"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true},"uuid":{"title":"Uuid","type":"string","format":"uuid","readOnly":true},"title":{"title":"Title","minLength":1,"type":"string","readOnly":true},"organization":{"$ref":"#/components/schemas/PublicOrganizationSummary"},"start_date":{"title":"Start date","type":"string","format":"date","readOnly":true},"end_date":{"title":"End date","type":"string","format":"date","nullable":true,"readOnly":true},"is_primary":{"title":"Is primary","type":"boolean","readOnly":true},"role_type":{"title":"Role type","type":"string","readOnly":true,"enum":["employee","contractor","candidate","contact"]}}},"PublicOrganizationSummary":{"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true},"uuid":{"title":"Uuid","type":"string","format":"uuid","readOnly":true},"name":{"title":"Name","minLength":1,"type":"string","readOnly":true},"type":{"title":"Type","minLength":1,"type":"string","readOnly":true},"archived":{"title":"Archived","type":"string","format":"date-time","nullable":true,"readOnly":true}}}}},"paths":{"/roles/":{"get":{"tags":["roles"],"operationId":"roles_list","parameters":[{"name":"search","in":"query","description":"A search term.","schema":{"type":"string"}},{"name":"ordering","in":"query","description":"Which field to use when ordering the results.","schema":{"type":"string"}},{"name":"role_type","in":"query","description":"role_type","schema":{"type":"string","enum":["employee","contractor","candidate","contact"]}},{"name":"is_primary","in":"query","description":"is_primary","schema":{"type":"string"}},{"name":"organization","in":"query","description":"organization","schema":{"type":"string"}},{"name":"person","in":"query","description":"person","schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number to retrieve (1-indexed).","schema":{"type":"integer"}},{"name":"page_size","in":"query","description":"Number of results per page. Defaults to the pagination class's page size and respects the configured maximum.","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"required":["count","results"],"type":"object","properties":{"count":{"type":"integer"},"next":{"type":"string","format":"uri","nullable":true},"previous":{"type":"string","format":"uri","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/PublicRoleSummary"}}}}}}}}}}}} ``` ## GET /roles/{id}/ > ```json {"openapi":"3.0.1","info":{"title":"Relabase Public API","version":"v1"},"servers":[{"url":"api.rekap.com/relabase/api/v1/public"}],"security":[{"Bearer":[]},{"Token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Authenticate using `Bearer ` format for internal endpoints","name":"Authorization","in":"header"},"Token":{"type":"apiKey","description":"Authenticate using `Token ` format","name":"Authorization","in":"header"}},"schemas":{"PublicRole":{"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true},"uuid":{"title":"Uuid","type":"string","format":"uuid","readOnly":true},"title":{"title":"Title","minLength":1,"type":"string","readOnly":true},"organization":{"$ref":"#/components/schemas/PublicOrganizationSummary"},"start_date":{"title":"Start date","type":"string","format":"date","readOnly":true},"end_date":{"title":"End date","type":"string","format":"date","nullable":true,"readOnly":true},"is_primary":{"title":"Is primary","type":"boolean","readOnly":true},"role_type":{"title":"Role type","type":"string","readOnly":true,"enum":["employee","contractor","candidate","contact"]},"person":{"$ref":"#/components/schemas/PublicPersonSummary"},"relationship_contexts":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/PublicRelationshipRoleContext"}},"created":{"title":"Created","type":"string","format":"date-time","readOnly":true},"modified":{"title":"Modified","type":"string","format":"date-time","readOnly":true}}},"PublicOrganizationSummary":{"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true},"uuid":{"title":"Uuid","type":"string","format":"uuid","readOnly":true},"name":{"title":"Name","minLength":1,"type":"string","readOnly":true},"type":{"title":"Type","minLength":1,"type":"string","readOnly":true},"archived":{"title":"Archived","type":"string","format":"date-time","nullable":true,"readOnly":true}}},"PublicPersonSummary":{"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true},"uuid":{"title":"Uuid","type":"string","format":"uuid","readOnly":true},"name":{"title":"Name","minLength":1,"type":"string","readOnly":true},"first_name":{"title":"First name","minLength":1,"type":"string","readOnly":true},"last_name":{"title":"Last name","minLength":1,"type":"string","readOnly":true},"preferred_name":{"title":"Preferred name","minLength":1,"type":"string","nullable":true,"readOnly":true},"linkedin_url":{"title":"Linkedin url","minLength":1,"type":"string","format":"uri","nullable":true,"readOnly":true},"phone":{"title":"Phone","minLength":1,"type":"string","nullable":true,"readOnly":true},"primary_work_email":{"title":"Primary work email","type":"string","nullable":true,"readOnly":true},"primary_personal_email":{"title":"Primary personal email","type":"string","nullable":true,"readOnly":true},"archived":{"title":"Archived","type":"string","format":"date-time","nullable":true,"readOnly":true},"created":{"title":"Created","type":"string","format":"date-time","readOnly":true},"modified":{"title":"Modified","type":"string","format":"date-time","readOnly":true}}},"PublicRelationshipRoleContext":{"type":"object","properties":{"id":{"title":"ID","type":"integer","readOnly":true},"relationship":{"title":"Relationship","type":"integer","readOnly":true},"relationship_uuid":{"title":"Relationship uuid","type":"string","format":"uuid","readOnly":true},"relationship_role":{"title":"Relationship role","minLength":1,"type":"string","readOnly":true},"description":{"title":"Description","minLength":1,"type":"string","description":"Description of the role in this relationship context","nullable":true,"readOnly":true},"created":{"title":"Created","type":"string","format":"date-time","readOnly":true},"modified":{"title":"Modified","type":"string","format":"date-time","readOnly":true}}}}},"paths":{"/roles/{id}/":{"get":{"tags":["roles"],"operationId":"roles_read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicRole"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.rekap.com/api/api-reference/roles.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.