{ "info": { "_postman_id": "f85777f0-2790-41cb-a27b-a08497394858", "name": "Spruce Health API \u2014 Contacts", "description": "Contacts operations of the Spruce Health API. Generated from the OpenAPI Spruce Health publishes for developer.sprucehealth.com.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "id": "e09bcedb-5c88-4556-ba66-e44ffff05017", "name": "Contacts", "item": [ { "id": "d72b18a9-3aa5-42c2-9cd4-9841cfeaee1d", "name": "List contacts", "request": { "name": "List contacts", "description": { "content": "This operation lists all contacts available to a given organization.\n\nThe `hasMore` field can be used to determine if there are remaining results to list. The `paginationToken` field can be provided on subsequents calls to retrieve the next page of results.", "type": "text/plain" }, "method": "GET", "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "disabled": false, "key": "pageSize", "value": "" }, { "disabled": false, "key": "paginationToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "4e8c3c89-2eb0-49f2-9ab4-a49a6f01487e", "name": "Create a contact", "request": { "name": "Create a contact", "description": { "content": "This operation creates a contact within an organization.\n\nCreating a new contact requires at least of the following fields to be populated (`givenName`, `familyName`, `phoneNumbers`, `faxNumbers`, `emailAddresses`).", "type": "text/plain" }, "method": "POST", "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [], "variable": [] }, "header": [ { "key": "s-idempotency-key", "value": "", "description": "A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long." }, { "key": "Authorization", "value": "Bearer {{bearerToken}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "051e3573-3d50-4df6-ac69-78c973cb63f5", "name": "Search contacts", "request": { "name": "Search contacts", "description": { "content": "This operation searches all contacts available to a given organization and returns a resulting set of results.\n\n\nThe `hasMore` field can be used to determine if there are remaining results to list. The `paginationToken` field can be provided on subsequents calls to retrieve the next page of results.\n\n\n## Sort Order\n\nResults are sorted by **entity ID in ascending order** when doing a structured search and by **relevance** for free text search.\n\nWhy is this a `POST`? `GET` requests with a body are not supported by all HTTP libraries. To support complex nested search filters and other tooling, the `POST` body is leveraged.", "type": "text/plain" }, "method": "POST", "url": { "raw": "{{baseUrl}}/contacts/search", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "search" ], "query": [ { "disabled": false, "key": "pageSize", "value": "" }, { "disabled": false, "key": "paginationToken", "value": "" } ], "variable": [] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "841622a8-b203-4564-a3a1-c2053e00d474", "name": "Delete a contact", "request": { "name": "Delete a contact", "description": { "content": "This operation deletes a specific contact by id.\n\nSee the `canDelete` field on a given contact to determine if deletion is allowed.", "type": "text/plain" }, "method": "DELETE", "url": { "raw": "{{baseUrl}}/contacts/{contactId}", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}" ], "query": [], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "372e707a-1ded-4c4b-9fa8-5c8c3f63283d", "name": "Get a contact by Spruce Contact ID", "request": { "name": "Get a contact by Spruce Contact ID", "description": { "content": "This operation retrieves a specific contact by id.", "type": "text/plain" }, "method": "GET", "url": { "raw": "{{baseUrl}}/contacts/{contactId}", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}" ], "query": [], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "a7906884-1d1f-43d4-ac33-52c29092f224", "name": "Update a contact", "request": { "name": "Update a contact", "description": { "content": "This operation updates a specific contact by id.\n\nFields provided in the input object will be updated, omitted fields *(null)* will be unchanged.", "type": "text/plain" }, "method": "PATCH", "url": { "raw": "{{baseUrl}}/contacts/{contactId}", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}" ], "query": [], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "s-idempotency-key", "value": "", "description": "A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long." }, { "key": "Authorization", "value": "Bearer {{bearerToken}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "6cbb289f-f48f-40e0-9114-b9ea9323c327", "name": "List the conversations associated with a contact", "request": { "name": "List the conversations associated with a contact", "description": { "content": "This operation retrieves the conversations associated with a contact", "type": "text/plain" }, "method": "GET", "url": { "raw": "{{baseUrl}}/contacts/{contactId}/conversations", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}", "conversations" ], "query": [], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "bf286a6a-7e64-4a6e-aab3-db7a7c0fa195", "name": "Delete an integration link", "request": { "name": "Delete an integration link", "description": { "content": "This operation deletes a specific integration link associated with a contact.", "type": "text/plain" }, "method": "DELETE", "url": { "raw": "{{baseUrl}}/contacts/{contactId}/integrationlinks", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}", "integrationlinks" ], "query": [ { "disabled": false, "key": "type", "value": "" }, { "disabled": false, "key": "externalId", "value": "" } ], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "cd9c2e02-bd7a-4e9c-acd4-e909a155dca3", "name": "List the integration links associated with a contact", "request": { "name": "List the integration links associated with a contact", "description": { "content": "This operation retrieves the integration links associated with a contact", "type": "text/plain" }, "method": "GET", "url": { "raw": "{{baseUrl}}/contacts/{contactId}/integrationlinks", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}", "integrationlinks" ], "query": [], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" } ] }, "response": [] }, { "id": "71b44753-3efc-432a-a875-e498a4f6899d", "name": "Create an integration link", "request": { "name": "Create an integration link", "description": { "content": "This operation creates a link between a contact and an external system with which the Spruce account is integrated.", "type": "text/plain" }, "method": "POST", "url": { "raw": "{{baseUrl}}/contacts/{contactId}/integrationlinks", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}", "integrationlinks" ], "query": [ { "disabled": false, "key": "type", "value": "" }, { "disabled": false, "key": "externalId", "value": "" } ], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "s-idempotency-key", "value": "", "description": "A unique value generated by the client used to recognize subsequent retries of the same request. Idempotency keys can be up to 255 characters long." }, { "key": "Authorization", "value": "Bearer {{bearerToken}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "6c2d9952-a257-4b9e-8cec-6fa2950b163e", "name": "Invite patient to Spruce", "request": { "name": "Invite patient to Spruce", "description": { "content": "This operation sends an invite to a patient contact:\n- If the contact is invited for the first time, a new secure conversation will be created,\n- If the contact is already invited, the invite will be re-sent to the same secure conversation,\n- If the contact is already on Spruce, an error will be returned.", "type": "text/plain" }, "method": "POST", "url": { "raw": "{{baseUrl}}/contacts/{contactId}/invite", "host": [ "{{baseUrl}}" ], "path": [ "contacts", "{contactId}", "invite" ], "query": [], "variable": [ { "key": "contactId", "value": "" } ] }, "header": [ { "key": "Authorization", "value": "Bearer {{bearerToken}}" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sprucehealth.com/v1" } ] }