{ "opencollection": "1.0.0", "info": { "name": "Capmo REST Organisation Companies Organisation People API", "version": "1.0" }, "items": [ { "info": { "name": "Organisation People", "type": "folder" }, "items": [ { "info": { "name": "getOrganisationPeople", "type": "http" }, "http": { "method": "GET", "url": "https://api.capmo.de/api/v1/organisation/people", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "order_by", "value": "", "type": "query", "description": "Field to order by." }, { "name": "order_direction", "value": "", "type": "query", "description": "Order direction of the `order_by` field. It can be `asc` or `desc`." }, { "name": "after", "value": "", "type": "query", "description": "The last element from the previous page. This is a cursor. It will be returned in the output to be used in the next request. When it is not present, the first page is returned. When it is `null`, there are no more pages." }, { "name": "limit", "value": "", "type": "query", "description": "How many items should be in the output." }, { "name": "source_id", "value": "", "type": "query", "description": "[Filtering Parameter] The unique identifier of the source. This is a user-generated string, used to link the person to a resource in an external system." }, { "name": "email", "value": "", "type": "query", "description": "[Filtering Parameter] The email address of the person. " } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to list all organisation contact book people in a paginated response." }, { "info": { "name": "createOrganisationPerson", "type": "http" }, "http": { "method": "POST", "url": "https://api.capmo.de/api/v1/organisation/people", "headers": [ { "name": "Request-Id", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to add a new organisation contact book person." }, { "info": { "name": "getOrganisationPerson", "type": "http" }, "http": { "method": "GET", "url": "https://api.capmo.de/api/v1/organisation/people/:personId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "personId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to retrieve a specific organisation person by its ID." }, { "info": { "name": "updateOrganisationPerson", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.capmo.de/api/v1/organisation/people/:personId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "personId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to update a specific organisation contact book person by its ID." }, { "info": { "name": "deleteOrganisationPerson", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.capmo.de/api/v1/organisation/people/:personId", "headers": [ { "name": "Request-Id", "value": "" } ], "params": [ { "name": "personId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "This can be used to delete an organisation contact book person. If the person is a member of the organisation, their membership will be deleted as well." } ] } ], "bundled": true }