--- title: Get a company by company ID slug: api/get-a-company-by-company-id docTags: createdAt: 2026-03-01T03:12:36.506Z --- { "id": "DuYPFQ8fAl9qBB35qA0bB", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://openapi.sine.co/v1/api/companies/company/{companyId}", "servers": [ { "url": "https://openapi.sine.co/v1/api/companies/company/{companyId}", "description": "Sine Public API" } ], "name": "Get a company by company ID", "description": "Fetches individual company details by its ID", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "companyId", "type": "string", "description": "The unique identifier of the company", "format": "uuid" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-sine-team-id", "type": "string", "description": "The UUID of the Team", "format": "uuid" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "bearerAuth", "kind": "optional", "type": "http", "description": "

To obtain a token, call POST /oauth2/token with your client_id and client_secret. The returned access_token is then used as a Bearer token for all subsequent requests.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "", "example": "5ac705fa211700000539cb25", "format": "uuid" }, { "name": "teamId", "kind": "optional", "type": "string", "description": "", "example": "f03cd429-9e80-4fdd-bd9a-d9dcbb2417fb", "format": "uuid" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Acme Corporation" }, { "name": "status", "kind": "optional", "type": "string", "description": "", "example": "active", "enum": [ "active", "inactive", "pending", "blocked" ] }, { "name": "identifierDetails", "kind": "optional", "type": "object", "nullable": true, "description": "", "example": "", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "address", "kind": "optional", "type": "string", "description": "", "example": "123 Business Street, Business City, BC 12345" }, { "name": "contactName", "kind": "optional", "type": "string", "description": "", "example": "John Doe" }, { "name": "contactEmail", "kind": "optional", "type": "string", "description": "", "example": "john.doe@acme.com", "format": "email" }, { "name": "contactPhoneNumber", "kind": "optional", "type": "string", "description": "", "example": "+1-555-123-4567" }, { "name": "website", "kind": "optional", "type": "string", "description": "", "example": "https://www.acme.com" }, { "name": "adminNotes", "kind": "optional", "type": "string", "description": "", "example": "Important client - handle with priority" }, { "name": "created", "kind": "optional", "type": "string", "description": "", "example": "2020-12-30T04:48:51.438Z", "format": "date-time" }, { "name": "updated", "kind": "optional", "type": "string", "description": "", "example": "2020-12-30T04:48:51.438Z", "format": "date-time" }, { "name": "tags", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "name", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "additionalFields", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "value", "kind": "optional", "type": "string", "description": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"BAD_REQUEST\",\"message\":\"The request is invalid\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "BAD_REQUEST" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom Error Message", "example": "The request is invalid" } ], "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"UNAUTHORIZED\",\"message\":\"Invalid authentication credentials\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "UNAUTHORIZED" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Invalid authentication credentials" } ], "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"FORBIDDEN\",\"message\":\"You are not allowed to access this information\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "FORBIDDEN" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "You are not allowed to access this information" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Resource not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"SITE_NOT_FOUND\",\"message\":\"SiteNotFoundError\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "SITE_NOT_FOUND" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "SiteNotFoundError" } ], "isExpanded": true } ] }, { "statusCode": "424", "description": "Service dependency failed", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"CONSUMER_ERROR\",\"message\":\"Unexpected error while communicating with downstream service, please try again\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "CONSUMER_ERROR" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Unexpected error while communicating with downstream service, please try again" } ], "isExpanded": true } ] }, { "statusCode": "429", "description": "Too many requests", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"RATE_LIMITED\",\"message\":\"API rate limit exceeded\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "RATE_LIMITED" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "API rate limit exceeded" } ], "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"INTERNAL_SERVER_ERROR\",\"message\":\"Something went wrong, please try again later\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "INTERNAL_SERVER_ERROR" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Something went wrong, please try again later" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "ZPwqGojqi40QMB_iuyYnC", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://openapi.sine.co/v1/api/companies/company/{companyId} \\\n --header 'accept: application/json' \\\n --header 'x-sine-team-id: string'" }, { "id": "0oYHPUkeSLgGoW2zAJ_jW", "language": "javascript", "label": "JavaScript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-sine-team-id\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://openapi.sine.co/v1/api/companies/company/{companyId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "amW-jz8BdQC4Rqt5Azawi", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://openapi.sine.co/v1/api/companies/company/{companyId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-sine-team-id': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "ZPwqGojqi40QMB_iuyYnC" }, "results": { "languages": [ { "id": "V6Dx6fE3jGjijVXOEHrIg", "language": "200", "code": "// OK\n{\n \"id\": \"5ac705fa211700000539cb25\",\n \"teamId\": \"f03cd429-9e80-4fdd-bd9a-d9dcbb2417fb\",\n \"name\": \"Acme Corporation\",\n \"status\": \"active\",\n \"identifierDetails\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"address\": \"123 Business Street, Business City, BC 12345\",\n \"contactName\": \"John Doe\",\n \"contactEmail\": \"john.doe@acme.com\",\n \"contactPhoneNumber\": \"+1-555-123-4567\",\n \"website\": \"https://www.acme.com\",\n \"adminNotes\": \"Important client - handle with priority\",\n \"created\": \"2020-12-30T04:48:51.438Z\",\n \"updated\": \"2020-12-30T04:48:51.438Z\",\n \"tags\": [\n {\n \"name\": \"\"\n }\n ],\n \"additionalFields\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"value\": \"\",\n \"type\": \"\"\n }\n ]\n}" }, { "id": "zLsrW0SkxzOWelzzgSqkA", "language": "400", "code": "// Bad request\n{\n \"code\": \"BAD_REQUEST\",\n \"message\": \"The request is invalid\"\n}" }, { "id": "yMLknQQb4uklkuHMXXHMi", "language": "401", "code": "// Unauthorized\n{\n \"code\": \"UNAUTHORIZED\",\n \"message\": \"Invalid authentication credentials\"\n}" }, { "id": "vePsH1-la55YgP8LT1Yi_", "language": "403", "code": "// Forbidden\n{\n \"code\": \"FORBIDDEN\",\n \"message\": \"You are not allowed to access this information\"\n}" }, { "id": "ICr7MRwi9wS7stwq-lwrL", "language": "404", "code": "// Resource not found\n{\n \"code\": \"SITE_NOT_FOUND\",\n \"message\": \"SiteNotFoundError\"\n}" }, { "id": "-H97ruQtcapT7ooOGX5pw", "language": "424", "code": "// Service dependency failed\n{\n \"code\": \"CONSUMER_ERROR\",\n \"message\": \"Unexpected error while communicating with downstream service, please try again\"\n}" }, { "id": "-T_Q4gVLi73mh0AHDMuE2", "language": "429", "code": "// Too many requests\n{\n \"code\": \"RATE_LIMITED\",\n \"message\": \"API rate limit exceeded\"\n}" }, { "id": "XX9Ec3Kp0uOKblLixVP6J", "language": "500", "code": "// Internal server error\n{\n \"code\": \"INTERNAL_SERVER_ERROR\",\n \"message\": \"Something went wrong, please try again later\"\n}" } ], "selectedLanguageId": "V6Dx6fE3jGjijVXOEHrIg" } }, "children": [ { "text": "" } ] }