API: Sample Calls

Go to API overview

There are a range of tools that can be used for making API calls. Postman is a popular choise, see https://www.postman.com/ You will need your keys added to an evironment as per the screenshot below, which will mean you don't need to add the keys to the header of every call you make. See this page for more info.

Copy and paste the the code below into a text editor, and save with a .json extension. The file can then be imported into Postman.

{
	"info": {
		"_postman_id": "10bed371-4395-442e-9a66-6a780d834776",
		"name": "Sample calls",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Getting Started",
			"item": [
				{
					"name": "Get Business Configuration",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Source",
								"value": "{{source}}",
								"type": "default"
							},
							{
								"key": "Org",
								"value": "{{org}}",
								"type": "default"
							},
							{
								"key": "User",
								"value": "{{user}}",
								"type": "default"
							}
						],
						"url": {
							"raw": "https://{{host}}/v2/business/configuration",
							"protocol": "https",
							"host": [
								"{{host}}"
							],
							"path": [
								"v2",
								"business",
								"configuration"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "clients",
			"item": [
				{
					"name": "Client by ID with default fields",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Org",
								"value": "{{org}}"
							},
							{
								"key": "Source",
								"value": "{{source}}"
							},
							{
								"key": "User",
								"value": "{{user}}"
							},
							{
								"key": "XDEBUG_SESSION",
								"value": "PHPSTORM"
							}
						],
						"url": {
							"raw": "https://{{host}}/v2/clients/id/123",
							"protocol": "https",
							"host": [
								"{{host}}"
							],
							"path": [
								"v2",
								"clients",
								"id",
								"123"
							]
						}
					},
					"response": []
				},
				{
					"name": "Client by ID with specific fields",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Org",
								"value": "{{org}}"
							},
							{
								"key": "Source",
								"value": "{{source}}"
							},
							{
								"key": "User",
								"value": "{{user}}"
							},
							{
								"key": "XDEBUG_SESSION",
								"value": "PHPSTORM"
							}
						],
						"url": {
							"raw": "https://{{host}}/v2/clients/id/123/field/name;id;living_arrangements;accommodation",
							"protocol": "https",
							"host": [
								"{{host}}"
							],
							"path": [
								"v2",
								"clients",
								"id",
								"123",
								"field",
								"name;id;living_arrangements;accommodation"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "referrals",
			"item": [
				{
					"name": "Referral by ID with default fields",
					"request": {
						"method": "GET",
						"header": [
							{
								"key": "Source",
								"value": "{{source}}"
							},
							{
								"key": "Org",
								"value": "{{org}}"
							},
							{
								"key": "User",
								"value": "{{user}}"
							},
							{
								"key": "XDEBUG_SESSION",
								"value": "PHPSTORM"
							}
						],
						"url": {
							"raw": "https://{{host}}/v2/referrals/id/1342",
							"protocol": "https",
							"host": [
								"{{host}}"
							],
							"path": [
								"v2",
								"referrals",
								"id",
								"1342"
							]
						}
					},
					"response": []
				}
			]
		}
	]
}