{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/subprojects/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial","admonition"]},"type":"markdown"},"seo":{"title":"API Reference Overview","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]},{"title":"Number Lookup API","description":"The Number Lookup API is designed to provide in-depth information about phone numbers, helping enterprises enhance their communication strategies and prevent fraud. By identifying the type of phone line (for example, mobile, landline, VoIP) and the associated carrier, the API allows businesses to optimize routing, reduce unnecessary costs, and improve customer engagement.","includeFiles":["docs/number-lookup-api-v2/**/*.md","docs/number-lookup-api-v2/**/*.yaml"],"excludeFiles":["docs/number-lookup-api-v2/index.md"]},{"title":"Functions","description":"Serverless compute for voice and messaging. Deploy your code and Sinch routes live calls and messages to it — no infrastructure to run.","includeFiles":["docs/functions/functions/**/*.md","docs/functions/concepts/**/*.md","docs/functions/reference/**/*.md"],"excludeFiles":["docs/functions/functions/index.md"]},{"title":"CLI","description":"One command line for every Sinch API and the full Functions lifecycle — scaffold, run locally, deploy, and manage.","includeFiles":["docs/functions/cli/**/*.md"],"excludeFiles":["docs/functions/cli/index.md"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-reference-overview","__idx":0},"children":["API Reference Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"ConnectButton","attributes":{"title":"Sinch Agentic Tools","icon":"aiCode","option":[{"title":"Sinch Plugins","description":"Install Sinch Plugins","icon":"connection","link":"https://github.com/sinch/sinch-plugins#installation"},{"title":"Sinch Skills","description":"Install Sinch Skills","icon":"ai","link":"https://github.com/sinch/skills#installation"}]},"children":[]}," ",{"$$mdtype":"Tag","name":"ConnectButton","attributes":{"title":"Sinch SDKs","icon":"code","option":[{"title":"Sinch Node.js SDK","description":"Install Sinch Node.js SDK","icon":"node","link":"/docs/sdks/node#installation"},{"title":"Sinch Java SDK","description":"Install Sinch Java SDK","icon":"java","link":"/docs/sdks/java#installation"},{"title":"Sinch .NET SDK","description":"Install Sinch .NET SDK","icon":"dotnet","link":"/docs/sdks/dotnet#installation"},{"title":"Sinch Python SDK","description":"Install Sinch Python SDK","icon":"python","link":"/docs/sdks/python#installation"}]},"children":[]}," ",{"$$mdtype":"Tag","name":"ConnectButton","attributes":{"title":"Sinch CLI & Functions","icon":"window","option":[{"title":"Sinch CLI","description":"Install Sinch CLI","icon":"cli","link":"/docs/functions/cli/installation"},{"title":"Sinch Functions","description":"Quickstart Sinch Functions","icon":"code","link":"/docs/functions/functions/quickstart"}]},"children":[]}," ",{"$$mdtype":"Tag","name":"ConnectMCP","attributes":{"placement":"bottom","alignment":"start","options":["cursor","vscode","copy"]},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":1},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authentication is performed using the API key from a parent project in your ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["Sinch Build Dashboard"]},". You can use an existing key or create a new one."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["We use OAuth 2.0 to create a bearer token. The bearer token can be used to make calls to the Subprojects API."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note:"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There may be ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["up to a 30 second delay"]}," between subproject creation and use with a parent project."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"exchange-credentials-for-an-access-token","__idx":2},"children":["Exchange credentials for an access token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Exchange your ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key ID"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Secret"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["found in the Sinch Build Dashboard"]}," for a bearer token (also known as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access_token"]},")."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl https://auth.sinch.com/oauth2/token -d grant_type=client_credentials --user YOUR_Key_ID:YOUR_Key_Secret\n","lang":"curl"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access_token"]}," will be included in a successful response. The access token can be used as the bearer token in each call to the Subprojects API. For example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl https://subproject.api.sinch.com/v1/projects/YOUR_parent_project_ID/subprojects \n-H \"Authorization: Bearer YOUR_access_token\" \n","lang":"curl"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The bearer token is valid for one hour."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"basic-authentication","__idx":3},"children":["Basic Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Basic authentication is also an option with the Subprojects API by using a ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["key ID and key secret"]}," to authenticate requests. You can view and manage your API keys ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dashboard.sinch.com/settings/access-keys"},"children":["here"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Basic authentication should only be used for testing or prototyping. For production environments, we recommend using access tokens."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authentication to the API is performed via ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"http://en.wikipedia.org/wiki/Basic_access_authentication"},"children":["HTTP Basic Auth"]},". Use your key ID as the basic auth username and your key secret as the password."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"shell","header":{"controls":{"copy":{}}},"source":" --url 'https://subproject.api.sinch.com/v1/projects/${parentProjectId}/subprojects' \\\n --header 'Accept: application/json' \\\n -u YOUR_Key_ID:YOUR_Key_secret\n","lang":"shell"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"server-url","__idx":4},"children":["Server URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The server URL is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subproject.api.sinch.com"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"json","__idx":5},"children":["JSON"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["JSON (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},") is the content type of both requests and responses if not otherwise specified."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requests with invalid JSON will be rejected."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"status-codes","__idx":6},"children":["Status codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A summary of status codes can be found on the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/subprojects/api-reference/status-codes"},"children":["error codes page"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"new-features","__idx":7},"children":["New features"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["New features might result in additional request and response parameters. New request parameters will either have a default value or be considered optional to retain backwards compatibility."]}]},"headings":[{"value":"API Reference Overview","id":"api-reference-overview","depth":1},{"value":"Authentication","id":"authentication","depth":2},{"value":"Exchange credentials for an access token","id":"exchange-credentials-for-an-access-token","depth":3},{"value":"Basic Authentication","id":"basic-authentication","depth":3},{"value":"Server URL","id":"server-url","depth":2},{"value":"JSON","id":"json","depth":2},{"value":"Status codes","id":"status-codes","depth":2},{"value":"New features","id":"new-features","depth":2}],"frontmatter":{"title":"Subproject API reference - Overview | Sinch","description":"General information about the Subprojects API.","seo":{"title":"API Reference Overview"}},"lastModified":"2026-07-27T14:39:03.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/subprojects/api-reference","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}