The identifier itself, in the form named by type. A PHONE is read like the cellphone of a contact write: a number without a country code is read in the workspace's default country, and spacing and separators are ignored. An EMAIL has its domain lowercased, but its local part is matched exactly as sent.
Id of the Bridge User who owns this contact. Resolve it with GET /users/{userId}.
Example:
"37673840-6259-40f9-bbe5-a7db40f8e3cf"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bridge REST Integrations API \u0026 Webhooks","description":"Documentation for Bridge Integrations API Webhooks","colors":{"primary":"#2563EB","light":"#3B82F6","dark":"#1D4ED8"},"logo":{"light":"https://mintcdn.com/sainapsisinc/MRBSc5DvZcNEOxd1/logo/bridge_full_logo_light.png?fit=max\u0026auto=format\u0026n=MRBSc5DvZcNEOxd1\u0026q=85\u0026s=9a9d74ac33a89d538635507ba8d12eb9","dark":"https://mintcdn.com/sainapsisinc/MRBSc5DvZcNEOxd1/logo/bridge_full_logo_dark.png?fit=max\u0026auto=format\u0026n=MRBSc5DvZcNEOxd1\u0026q=85\u0026s=0c0905478472ab3f3b07066824f7f4ca"},"favicon":"https://mintcdn.com/sainapsisinc/OxyPsTqCEnnNpE4v/favicon.png?fit=max\u0026auto=format\u0026n=OxyPsTqCEnnNpE4v\u0026q=85\u0026s=8262683efaf26e188f464e1f0f02a189","navbar":{"links":[{"href":"mailto:support@sainapsis.com","label":"Contact Support"}],"primary":{"type":"button","label":"Bridge app","href":"https://app.bridge.new"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/sainapsis-inc"}},"markdown":{"instructions":["Bridge exposes three integration surfaces: the REST Integrations API for pushing data into Bridge, webhooks for receiving events from Bridge, and the public Lead Capture endpoint that a tenant's landing page posts to.","The Integrations API host is https://api-connect-us.bridge.new and every request to it must be authenticated with the x-api-key header. Bridge does not use bearer tokens or OAuth.","The Lead Capture endpoint is different and the Integrations API rules do not apply to it: it has its own host, it takes no x-api-key and no authentication header of any kind, and it is called from a visitor's browser. It is identified by a workspace id and a capture key together with a reCAPTCHA token. Never tell a reader to authenticate it with an API key, and never tell them to keep its capture key out of frontend code - it is designed to live in the page.","Integrations API error codes follow the BRIDGE_\u003cDOMAIN>_\u003cNNNN> format, for example BRIDGE_CONVERSATION_0001, and are listed on the error codes page. Lead Capture error codes follow a different format, BRIDGE.CAMPAIGN_LEADS.\u003cNAME>, and are listed on the Lead Capture error reference. Never invent a code that is not listed on the page for its own surface.","This documentation covers the Integrations API, webhooks and Lead Capture only. It does not describe the Bridge web application or its internal APIs."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sainapsisinc","hasAudioNarration":false,"actualSubdomain":"sainapsisinc","customDomains":["docs.bridge.new"],"gitSource":{"type":"github","owner":"sainapsis","repo":"open-api-public-documentation-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af09e0d8195d769ef25cb59","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"REST API","count":25},{"language":"default","tag":"Introduction","count":7},{"language":"default","tag":"Lead Capture","count":6},{"language":"default","tag":"Contacts API","count":6},{"language":"default","tag":"Conversations API","count":5},{"language":"default","tag":"Webhooks","count":4},{"language":"default","tag":"Integration","count":3},{"language":"default","tag":"Internal Users API","count":3},{"language":"default","tag":"Before you launch","count":2},{"language":"default","tag":"Agents API","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:2.5rem}"}],"page":{"pagePath":"api-reference/contacts-api/retrieve-a-contact-by-an-identifier","slug":"/api-reference/contacts-api/retrieve-a-contact-by-an-identifier","pageMetadata":{"title":"Retrieve a contact by an identifier","description":"Get a specific contact by any of its identifiers within the workspace.\n\n`type=ID` returns the same contact as GET /contacts/{contactId}, which is the canonical\nURL for a contact and the one to prefer when the id is what you hold.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts/lookup","href":"/api-reference/contacts-api/retrieve-a-contact-by-an-identifier","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Get a specific contact by any of its identifiers within the workspace.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"type=ID\"\n }), \" returns the same contact as GET /contacts/\", \", which is the canonical\\nURL for a contact and the one to prefer when the id is what you hold.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a contact by an identifier","description":"Get a specific contact by any of its identifiers within the workspace.\n\n`type=ID` returns the same contact as GET /contacts/{contactId}, which is the canonical\nURL for a contact and the one to prefer when the id is what you hold.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts/lookup","href":"/api-reference/contacts-api/retrieve-a-contact-by-an-identifier","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Contacts API"],"summary":"Retrieve a contact by an identifier","description":"Get a specific contact by any of its identifiers within the workspace.\n\n`type=ID` returns the same contact as GET /contacts/{contactId}, which is the canonical\nURL for a contact and the one to prefer when the id is what you hold.","operationId":"retrieve_contact_by_identifier_bridge_api_v1_workspaces__workspaceId__contacts_lookup_get","security":["be1fb11d-6145-4af6-97e6-f8475268ef99"],"parameters":["c9f01562-4c63-4e63-8c1c-0a51f7a6c3f0","b233b397-895f-486f-845a-28887f0a71ab","f62059e5-7421-4fab-bcdb-c50808e9d7e6"],"responses":{"200":"4ed7cd22-3bfa-44ac-95b2-4e89e7583112","403":"20b9f400-50cc-4be7-a9c3-08567bd7570c","404":"3ecbbb6d-25d4-404c-bfce-e749c009fbd7","422":"18ecb1af-903a-4fa1-aba8-63b7390c916c","429":"d7a28b11-afae-4905-82a5-4c15a6fc34d9"},"method":"get","type":"path","servers":["1d313a3b-99ef-4546-a3e5-e937a25d61f5"],"path":"/bridge/api/v1/workspaces/{workspaceId}/contacts/lookup","baseUrlOptions":["https://api-connect-us.bridge.new"],"title":"Retrieve a contact by an identifier","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c9f01562-4c63-4e63-8c1c-0a51f7a6c3f0":{"name":"workspaceId","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Unique identifier of the workspace (UUID v4).","examples":["b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"],"title":"Workspaceid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Unique identifier of the workspace (UUID v4)."},"b233b397-895f-486f-845a-28887f0a71ab":{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["ID","EMAIL","PHONE"],"title":"ParticipantIdentifierType","description":"Identifier the value is given as.","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Identifier the value is given as."},"f62059e5-7421-4fab-bcdb-c50808e9d7e6":{"name":"value","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":320,"description":"The identifier itself, in the form named by `type`. A `PHONE` is read like the cellphone of a contact write: a number without a country code is read in the workspace's default country, and spacing and separators are ignored. An `EMAIL` has its domain lowercased, but its local part is matched exactly as sent.","title":"Value","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"The identifier itself, in the form named by `type`. A `PHONE` is read like the cellphone of a contact write: a number without a country code is read in the workspace's default country, and spacing and separators are ignored. An `EMAIL` has its domain lowercased, but its local part is matched exactly as sent.","examples":{"cellphone":{"summary":"A cellphone","description":"Send with `type=PHONE`. A value that cannot be read as a cellphone is refused before any lookup happens.","value":"+14084029292"},"email":{"summary":"An email address","description":"Send with `type=EMAIL`. `John.Doe@example.com` and `john.doe@example.com` are different identifiers and do not resolve to the same contact.","value":"john.doe@example.com"},"id":{"summary":"The contact id","description":"Send with `type=ID`. Returns exactly what `GET /contacts/{contactId}` returns, which stays the canonical URL for a contact.","value":"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"}}}},"responses":{"4ed7cd22-3bfa-44ac-95b2-4e89e7583112":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Identifier","description":"Unique identifier for the contact (UUID v4).","examples":["b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"],"isRequired":true,"uniqueKey":"id","typeLabel":"string"},"workspaceId":{"type":"string","title":"Workspace Identifier","description":"Unique identifier of the workspace this contact belongs to","examples":["92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5"],"isRequired":true,"uniqueKey":"workspaceId","typeLabel":"string"},"type":{"type":"string","enum":["PARTIAL","NORMAL"],"title":"Contact Type","description":"NORMAL when all required identity and custom attribute fields are present, PARTIAL otherwise.","examples":["NORMAL","PARTIAL"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","title":"Created At","description":"Timestamp when the contact was created.","examples":["2003-04-10T08:00:00.000Z"],"isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"updatedAt":{"type":"string","title":"Updated At","description":"Timestamp when the contact was last updated.","examples":["2003-04-10T08:00:00.000Z"],"isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","title":"First Name","description":"Contact's first name.","example":"John","uniqueKey":"firstName.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Name","description":"Contact's first name.","example":"John","uniqueKey":"firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","title":"Last Name","description":"Contact's last name.","example":"Doe","uniqueKey":"lastName.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Name","description":"Contact's last name.","example":"Doe","uniqueKey":"lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","title":"Email","description":"Contact's email address.","format":"email","example":"john.doe@example.com","uniqueKey":"email.oneOf.0","typeLabel":"string\u003cemail>"},{"type":"null","title":"Email","description":"Contact's email address.","example":"john.doe@example.com","uniqueKey":"email.oneOf.1","typeLabel":"null"}],"uniqueKey":"email","typeLabel":"string\u003cemail> | null"},"cellphone":{"oneOf":[{"type":"string","title":"Cellphone","description":"Contact's cellphone address.","format":"phone","example":"+14084029292","uniqueKey":"cellphone.oneOf.0","typeLabel":"string\u003cphone>"},{"type":"null","title":"Cellphone","description":"Contact's cellphone address.","example":"+14084029292","uniqueKey":"cellphone.oneOf.1","typeLabel":"null"}],"uniqueKey":"cellphone","typeLabel":"string\u003cphone> | null"},"customAttributes":{"items":{"properties":{"key":{"type":"string","title":"Key","description":"Attribute key/name","isRequired":true,"uniqueKey":"customAttributes.items.[INDEX].key","typeLabel":"string"},"values":{"items":{"type":"string","uniqueKey":"customAttributes.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Values","description":"Attribute value","uniqueKey":"customAttributes.items.[INDEX].values","typeLabel":"string[]"}},"type":"object","required":["key"],"title":"CustomAttributeResponse","description":"Response body for custom attributes in contact-related operations.","uniqueKey":"customAttributes.items.[INDEX]","typeLabel":"CustomAttributeResponse · object"},"type":"array","title":"Custom Attributes","description":"Array of custom key-value attributes.","uniqueKey":"customAttributes","typeLabel":"CustomAttributeResponse · object[]"},"languageCode":{"oneOf":[{"type":"string","title":"LanguageCode","description":"Language code from external user.","enum":["ES","EN","AF","SQ","AR","AZ","BN","BG","CA","ZH_CN","HR","CS","DA","NL","ET","FIL","FI","FR","KA","DE","EL","GU","HA","HE","HI","HU","ID","GA","IT","JA","KN","KK","RW_RW","KO","KY_KG","LO","LV","LT","MK","MS","ML","MR","NB","FA","PL","PT_BR","PA","RO","RU","SR","SK","SL","SW","SV","TA","TE","TH","TR","UK","UR","UZ","VI","ZU"],"example":"EN","uniqueKey":"languageCode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Language Code","description":"Language code from external user.","example":"EN","uniqueKey":"languageCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"languageCode","typeLabel":"enum\u003cstring> | null"},"ownerId":{"oneOf":[{"type":"string","title":"Owner Identifier","description":"Id of the Bridge User who owns this contact. Resolve it with `GET /users/{userId}`.","example":"37673840-6259-40f9-bbe5-a7db40f8e3cf","uniqueKey":"ownerId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Owner Identifier","description":"Id of the Bridge User who owns this contact. Resolve it with `GET /users/{userId}`.","example":"37673840-6259-40f9-bbe5-a7db40f8e3cf","uniqueKey":"ownerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"ownerId","typeLabel":"string | null"}},"type":"object","required":["id","workspaceId","type","createdAt","updatedAt"],"title":"ContactResponse","description":"Response body for contact-related operations.","uniqueKey":"","typeLabel":"ContactResponse · object"},"examples":{"Example":{"title":"Example","value":{"id":"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234","workspaceId":"92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5","type":"NORMAL","createdAt":"2003-04-10T08:00:00.000Z","updatedAt":"2003-04-10T08:00:00.000Z","firstName":"John","lastName":"Doe","email":"john.doe@example.com","cellphone":"+14084029292","customAttributes":[{"key":"\u003cstring>","values":["\u003cstring>"]}],"languageCode":"EN","ownerId":"37673840-6259-40f9-bbe5-a7db40f8e3cf"}}},"exampleType":"generated"}},"exampleType":"generated"},"20b9f400-50cc-4be7-a9c3-08567bd7570c":{"description":"Forbidden","content":{"application/json":{"examples":{"FORBIDDEN":{"title":"FORBIDDEN","value":{"title":"Forbidden","status":403,"code":"BRIDGE_CORE_0301"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Short, summary of the problem type.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"HTTP status code generated by the origin server for this occurrence of the problem.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Extra information about the problem.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Extra information about the problem.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Object representing a Problem response body.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"},"3ecbbb6d-25d4-404c-bfce-e749c009fbd7":{"description":"Not Found","content":{"application/json":{"examples":{"WORKSPACE_NOT_FOUND":{"title":"WORKSPACE_NOT_FOUND","value":{"title":"Workspace Not Found","status":404,"code":"BRIDGE_WORKSPACE_0001"}},"EXTERNAL_USER_NOT_FOUND":{"title":"EXTERNAL_USER_NOT_FOUND","value":{"title":"External User Not Found","status":404,"code":"BRIDGE_EXTERNAL_0001"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Short, summary of the problem type.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"HTTP status code generated by the origin server for this occurrence of the problem.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Extra information about the problem.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Extra information about the problem.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Object representing a Problem response body.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"},"18ecb1af-903a-4fa1-aba8-63b7390c916c":{"description":"Unprocessable Content","content":{"application/json":{"examples":{"INVALID_FIELD_FORMAT":{"title":"INVALID_FIELD_FORMAT","value":{"title":"Invalid Field Format","status":422,"code":"BRIDGE_CORE_0101"}}},"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Short, summary of the problem type.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"HTTP status code generated by the origin server for this occurrence of the problem.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Extra information about the problem.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Extra information about the problem.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Object representing a Problem response body.","uniqueKey":"","typeLabel":"Problem · object"},"exampleType":"examples"}},"exampleType":"examples"},"d7a28b11-afae-4905-82a5-4c15a6fc34d9":{"description":"Too Many Requests","content":{"application/json":{"schema":{"properties":{"title":{"type":"string","title":"Title","description":"Short, summary of the problem type.","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","title":"Status","description":"HTTP status code generated by the origin server for this occurrence of the problem.","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"oneOf":[{"type":"string","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","title":"Detail","description":"Explanation specific to this occurrence of the problem.","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","title":"Instance","description":"A URI reference that identifies the specific occurrence of the problem.","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"traceId":{"oneOf":[{"type":"string","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.0","typeLabel":"string"},{"type":"null","title":"Traceid","description":"Trace ID for debugging purposes.","uniqueKey":"traceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"traceId","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.0","typeLabel":"string"},{"type":"null","title":"Code","description":"Error code for identification, view the error codes page for more details.","uniqueKey":"code.oneOf.1","typeLabel":"null"}],"uniqueKey":"code","typeLabel":"string | null"},"errors":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"errors.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.0","typeLabel":"Errors · object[]"},{"type":"null","title":"Errors","description":"List of error details.","uniqueKey":"errors.oneOf.1","typeLabel":"null"}],"uniqueKey":"errors","typeLabel":"Errors · object[] | null"},"extra":{"oneOf":[{"type":"object","title":"Extra","description":"Extra information about the problem.","additionalProperties":true,"uniqueKey":"extra.oneOf.0","typeLabel":"Extra · object"},{"type":"null","title":"Extra","description":"Extra information about the problem.","uniqueKey":"extra.oneOf.1","typeLabel":"null"}],"uniqueKey":"extra","typeLabel":"Extra · object | null"}},"type":"object","required":["title","status"],"title":"Problem","description":"Object representing a Problem response body.","uniqueKey":"","typeLabel":"Problem · object"},"examples":{"WORKSPACE_BUDGET_EXHAUSTED":{"title":"WORKSPACE_BUDGET_EXHAUSTED","value":{"title":"Too Many Requests","status":429,"code":"BRIDGE_RATE_LIMIT_0001"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"be1fb11d-6145-4af6-97e6-f8475268ef99":{"x-api-key":{"type":"apiKey","description":"Copy the API key as provided by the Bridge Console.","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"}}},"servers":{"1d313a3b-99ef-4546-a3e5-e937a25d61f5":{"url":"https://api-connect-us.bridge.new","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Copy the API key as provided by the Bridge Console.","in":"header","name":"x-api-key","scopes":[],"schemeName":"x-api-key"},"schema":{"title":"x-api-key","type":"string","description":"Copy the API key as provided by the Bridge Console.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"x-api-key","name":"x-api-key"}],"title":"x-api-key"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"sainapsisinc","siteName":"Bridge REST Integrations API \u0026 Webhooks","title":"Retrieve a contact by an identifier - Bridge REST Integrations API \u0026 Webhooks","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T16:06:42.909Z","originalFileLocation":"api-reference/contacts-api/retrieve-a-contact-by-an-identifier.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get a specific contact by any of its identifiers within the workspace. type=ID returns the same contact as GET /contacts/{contactId}, which is the canonical URL for a contact and the one to prefer when the id is what you hold.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a contact by an identifier - Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a specific contact by any of its identifiers within the workspace. type=ID returns the same contact as GET /contacts/{contactId}, which is the canonical URL for a contact and the one to prefer when the id is what you hold.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sainapsisinc.mintlify.site/_mintlify/api/og/v2?division=Contacts+API\u0026amp;title=Retrieve+a+contact+by+an+identifier\u0026amp;description=Get+a+specific+contact+by+any+of+its+identifiers+within+the+workspace.%0A%0A%60type%3DID%60+returns+the+same+contact+as+GET+%2Fcontacts%2F%7BcontactId%7D%2C+which+is+the+canonical%0A\u0026amp;theme=fbb9ff84c04418b3fc52c1b9\u0026amp;signature=0946564cf962be28190e1fbdd36f2b5054db38d0da66f01159baf30917f0ad55\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a contact by an identifier - Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a specific contact by any of its identifiers within the workspace. type=ID returns the same contact as GET /contacts/{contactId}, which is the canonical URL for a contact and the one to prefer when the id is what you hold.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sainapsisinc.mintlify.site/_mintlify/api/og/v2?division=Contacts+API\u0026amp;title=Retrieve+a+contact+by+an+identifier\u0026amp;description=Get+a+specific+contact+by+any+of+its+identifiers+within+the+workspace.%0A%0A%60type%3DID%60+returns+the+same+contact+as+GET+%2Fcontacts%2F%7BcontactId%7D%2C+which+is+the+canonical%0A\u0026amp;theme=fbb9ff84c04418b3fc52c1b9\u0026amp;signature=0946564cf962be28190e1fbdd36f2b5054db38d0da66f01159baf30917f0ad55\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/sainapsisinc/LWksyfunHyleJ2tH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bridge REST Integrations API \u0026amp; Webhooks\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/contacts-api/retrieve-a-contact-by-an-identifier.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bridge.new/#organization\",\"name\":\"Bridge REST Integrations API \u0026 Webhooks\",\"url\":\"https://docs.bridge.new\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sainapsisinc/MRBSc5DvZcNEOxd1/logo/bridge_full_logo_light.png?fit=max\u0026auto=format\u0026n=MRBSc5DvZcNEOxd1\u0026q=85\u0026s=9a9d74ac33a89d538635507ba8d12eb9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bridge.new#website\",\"name\":\"Bridge REST Integrations API \u0026 Webhooks\",\"url\":\"https://docs.bridge.new\",\"publisher\":{\"@id\":\"https://docs.bridge.new/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier#webpage\",\"url\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier\",\"name\":\"Retrieve a contact by an identifier\",\"description\":\"Get a specific contact by any of its identifiers within the workspace. type=ID returns the same contact as GET /contacts/{contactId}, which is the canonical URL for a contact and the one to prefer when the id is what you hold.\",\"dateModified\":\"2026-11-08T16:06:42.909Z\",\"isPartOf\":{\"@id\":\"https://docs.bridge.new#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Bridge REST Integrations API \u0026 Webhooks\",\"item\":\"https://docs.bridge.new\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a contact by an identifier\",\"item\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier#apireference\",\"headline\":\"Retrieve a contact by an identifier\",\"name\":\"Retrieve a contact by an identifier\",\"description\":\"Get a specific contact by any of its identifiers within the workspace. type=ID returns the same contact as GET /contacts/{contactId}, which is the canonical URL for a contact and the one to prefer when the id is what you hold.\",\"url\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bridge.new/api-reference/contacts-api/retrieve-a-contact-by-an-identifier#webpage\"},\"dateModified\":\"2026-11-08T16:06:42.909Z\",\"publisher\":{\"@id\":\"https://docs.bridge.new/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bridge.new#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bridge REST Integrations API \u0026 Webhooks\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bridge REST Integrations API \u0026 Webhooks","nav":{"global":null,"tabs":[{"tab":"Introduction","pages":[{"title":"Introduction","href":""}]},{"tab":"REST API","groups":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/health","href":"/api-reference/health/health-check"}]},{"group":"Conversations API","pages":[{"title":"Get conversation by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}","href":"/api-reference/conversations-api/get-conversation-by-id"},{"title":"Update conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}","href":"/api-reference/conversations-api/update-conversation"},{"title":"Retrieve conversations with flexible filtering options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/conversations","href":"/api-reference/conversations-api/retrieve-conversations-with-flexible-filtering-options"},{"title":"Creates a new conversation with flexible user identification.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/conversations","href":"/api-reference/conversations-api/creates-a-new-conversation-with-flexible-user-identification"},{"title":"Release conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/conversations/{conversationId}/release","href":"/api-reference/conversations-api/release-conversation"}]},{"group":"Messages API","pages":[{"title":"Create a new message","description":"Create a new message within a specified conversation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/messages","href":"/api-reference/messages-api/create-a-new-message"}]},{"group":"Contacts API","pages":[{"title":"Retrieve a contact by an identifier","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts/lookup","href":"/api-reference/contacts-api/retrieve-a-contact-by-an-identifier"},{"title":"Retrieve a contact by ID","description":"Get a specific contact by its unique identifier within the workspace.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}","href":"/api-reference/contacts-api/retrieve-a-contact-by-id"},{"title":"Update contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}","href":"/api-reference/contacts-api/update-contact"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/contacts","href":"/api-reference/contacts-api/list-contacts"},{"title":"Create a new contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/contacts","href":"/api-reference/contacts-api/create-a-new-contact"},{"title":"Create or update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/contacts/partial","href":"/api-reference/contacts-api/create-or-update-a-contact"}]},{"group":"Files API","pages":[{"title":"Create presigned uploads for files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/files","href":"/api-reference/files-api/create-presigned-uploads-for-files"}]},{"group":"Custom attributes API","pages":[{"title":"Retrieve custom attributes by workspaceId","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/settings/attributes","href":"/api-reference/custom-attributes-api/retrieve-custom-attributes-by-workspaceid"}]},{"group":"Provider channels API","pages":[{"title":"Get provider channels by workspace id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/provider-channels","href":"/api-reference/provider-channels-api/get-provider-channels-by-workspace-id"},{"title":"Get provider channels by workspace id and provider type","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/provider-channels/{messageProviderType}","href":"/api-reference/provider-channels-api/get-provider-channels-by-workspace-id-and-provider-type"}]},{"group":"LeadScout API","pages":[{"title":"Initiate a LeadScout outbound conversation with a known lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/leadscout/outbound","href":"/api-reference/leadscout-api/initiate-a-leadscout-outbound-conversation-with-a-known-lead"},{"title":"Request a manual handoff of a LeadScout conversation to internal users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/leadscout/conversations/{conversationId}/handoff","href":"/api-reference/leadscout-api/request-a-manual-handoff-of-a-leadscout-conversation-to-internal-users"}]},{"group":"Templates API","pages":[{"title":"Discover a template's agnostic variable inventory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/templates/{templateId}","href":"/api-reference/templates-api/discover-a-templates-agnostic-variable-inventory"}]},{"group":"Internal Users API","pages":[{"title":"Retrieve an internal user by an identifier","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/users/lookup","href":"/api-reference/internal-users-api/retrieve-an-internal-user-by-an-identifier"},{"title":"Retrieve an internal user by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/users/{userId}","href":"/api-reference/internal-users-api/retrieve-an-internal-user-by-id"},{"title":"List internal users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/users","href":"/api-reference/internal-users-api/list-internal-users"}]},{"group":"Agents API","pages":[{"title":"List the Agents of a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /bridge/api/v1/workspaces/{workspaceId}/agents","href":"/api-reference/agents-api/list-the-agents-of-a-workspace"},{"title":"Start an outbound conversation with a Contact as a given Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /bridge/api/v1/workspaces/{workspaceId}/agents/{agentId}/outbound","href":"/api-reference/agents-api/start-an-outbound-conversation-with-a-contact-as-a-given-agent"}]}]},{"tab":"Lead Capture","pages":[{"title":"Lead Capture","href":"/lead-capture"}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks"}]}]},"basePath":"","title":"Retrieve a contact by an identifier - Bridge REST Integrations API \u0026 Webhooks","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}