{"info":{"_postman_id":"0912c05c-c4a1-4dd7-8ce4-f3f0f9f31b47","name":"Ignico API Documentation","description":"

Each Ignico instance exposes API for developers to consume in their applications.

The API allows you to automate some tasks you typically would do through Ignico web app interface like:

batch import of your data to your app,
get your calculation results, user actions, rewards etc.

You can check here what resources you can interact with and how your requests should look like.

Authorization

If you are a customer and have your own Ignico workspace set, you or one of your administrators have to create an API Key first.

To access any endpoint (except fetching access token) you have to be authorized. We use The OAuth 2.0 Authorization Framework to grant you access.

Conventions

All communication is done in REST way and JSON format is used for each request and response.

Every endpoint conforms to open source JSON API 1.0 Specification. You can find everything you need to know about this format in official docs on http://jsonapi.org.

Filtering

JSON API does not impose filtering params format (http://jsonapi.org/format/#fetching-filtering) so we chose to use it in array like notation.

To use a filter someFilter you need to send it as filter[someFilter]=someValue query parameter.

Of course you can combine multiple filters like this:

?filter[someFilter]=someValue&filter[otherFilter]=otherValue

Pagination

JSON API is agnostic about pagination strategy (http://jsonapi.org/format/#fetching-pagination) too so we chose to use page-based strategy.

By default you will fetch first page and first 25 records (other default page size can be specified by endpoints). You can get information about total records count, current page or current page size from meta (http://jsonapi.org/format/#document-meta) information.

To fetch other pages or more data you need to send it as page[number]=2&page[size]=10 query parameters.

Maximum page size may be limited and can be specified by endpoints to prevent sending too much data over single request.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4434021","collectionId":"0912c05c-c4a1-4dd7-8ce4-f3f0f9f31b47","publishedId":"RW89KUij","public":true,"customColor":{"top-bar":"FAFAFA","right-sidebar":"1D1B50","highlight":"469DE1"},"publishDate":"2018-05-28T08:26:00.000Z"},"item":[{"name":"Authorization","item":[{"name":"Issue new access token","event":[{"listen":"test","script":{"id":"2977f68a-4591-416e-a28f-af08d9d171d0","type":"text/javascript","exec":["tests[\"Successful POST request\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","var schema = {"," \"access_token\": {"," \"type\": \"string\""," }","};","tests[\"Issued Access Token\"] = tv4.validate(jsonData, schema);","","if (tv4.error) {"," console.log(\"Validation failed: \", tv4.error); ","}","","tests[\"Issued Bearer token\"] = jsonData.token_type == \"Bearer\";","","postman.setGlobalVariable(\"access_token\", jsonData.access_token);",""]}}],"id":"5db785df-c269-4126-a8dd-d59164d3aa33","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","description":"

Currently this is the only one available grant type

\n"},{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"}]},"url":"https://{{workspace}}.igni.co/api/v1/oauth2/token","description":"

\n","urlObject":{"protocol":"https","path":["api","v1","oauth2","token"],"host":["{{workspace}}","igni","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"5db785df-c269-4126-a8dd-d59164d3aa33"}],"id":"6e1f6d1d-0683-47d3-a29e-60ccb681f800","description":"

To interact with other endpoints your requests have to be authorized using OAuth2 access token.

To obtain a token your application can get it in exchange for API Keys using client credentials grant (id and secret).

\n","event":[{"listen":"prerequest","script":{"id":"4f96c7b1-8c43-4c31-ab34-36d8c87725a3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0c6e3768-a1ac-427a-8fc3-6210609c54c4","type":"text/javascript","exec":[""]}}],"_postman_id":"6e1f6d1d-0683-47d3-a29e-60ccb681f800"},{"name":"Resources","item":[{"name":"Actions","item":[{"name":"List all actions","event":[{"listen":"test","script":{"id":"c8719738-ab1a-485e-a80d-fcfbea5bb25d","type":"text/javascript","exec":["tests[\"Successful request\"] = responseCode.code === 200;"]}}],"id":"0932ca31-b067-44ab-9a62-4ecab10539e6","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://{{workspace}}.igni.co/api/v1/actions","description":"

Available filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	string	Action UUID
cancelled	int	1 = true, 0 = false
performerEmail	string	E-mail of user performing actions
paramsValueGreaterEqual	mixed	`>=` Value that can be compared with Action value (if exists)
paramsValueLessEqual	mixed	`<=` Value that can be compared with Action value (if exists)
takenAtGreaterEqual	string	`>=` Date when Action was taken (`YYYY-MM-DD hh:mm:ss` 24hr format)
takenAtLessEqual	string	`<=` Date when Action was taken (`YYYY-MM-DD hh:mm:ss` 24hr format)
cancelledAtGreaterEqual	string	`>=` Date when Action was cancelled (`YYYY-MM-DD hh:mm:ss` 24hr format)
cancelledAtLessEqual	string	`<=` Date when Action was cancelled (`YYYY-MM-DD hh:mm:ss` 24hr format)

Available sortings

id
cancelled
takenAt
createdAt

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
type	string	`action`
attributes.type	string	Slug from declared active Action Types (e.g. `transaction`, `event`, `sign-up`)
attributes.title	string	Title of the Action
attributes.takenAt	string	Date when the Action was taken
attributes.performer.email	string	Email of the User that performed the Action
attributes.referrer.email	string	Email of the User that referred the Action
attributes.params.value	mixed	Value (only for the Action Type with parameter `value`)
attributes.params.points	mixed	Points (only for the Action Type with parameter `points`)

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","actions"],"host":["{{workspace}}","igni","co"],"query":[],"variable":[]}},"response":[{"id":"22bad6f8-b50a-4761-a5b8-592eaa5dac13","name":"Sample event","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"action\",\n \"attributes\": {\n \t\"type\": \"event\",\n \"title\": \"User attended meeting\",\n \"takenAt\": \"2018-05-06 22:46:25\",\n \"performer\": {\n \t\"email\": \"performer@example.com\"\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/actions"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"545ac4a0-bbb7-4a0f-a959-485b39fd942a","name":"Sample transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"action\",\n \"attributes\": {\n \t\"type\": \"transaction\",\n \"title\": \"Purchase\",\n \"takenAt\": \"2018-05-06 22:46:25\",\n \"performer\": {\n \t\"email\": \"performer@example.com\"\n },\n \"params\": {\n \"value\": 7419.22\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/actions"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d8299de6-77fe-4085-a89b-ebac77daad82"},{"name":"Cancel the action","event":[{"listen":"test","script":{"id":"7ee90285-3ee4-4fe0-b120-312748d8051a","type":"text/javascript","exec":["tests[\"Successful request\"] = responseCode.code === 200;"]}}],"id":"ce1d014f-99e5-4684-bde0-a28ba0e53865","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"action\",\n \"attributes\": {\n \"cancelled\": \"1\"\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/actions/{{action_id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","actions","{{action_id}}"],"host":["{{workspace}}","igni","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce1d014f-99e5-4684-bde0-a28ba0e53865"}],"id":"1decca58-56f3-45a2-9af0-cdbb03a55a90","description":"

Manage Actions that your users have taken.

May it be a sale, a lead, a meeting or any other activity you wish to use to reward your user.

\n","event":[{"listen":"prerequest","script":{"id":"f0579576-e2e5-4842-82d4-c534ae7300ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3e9bebba-a854-47b1-bd73-dd386b9acf0e","type":"text/javascript","exec":[""]}}],"_postman_id":"1decca58-56f3-45a2-9af0-cdbb03a55a90","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}}},{"name":"Users","item":[{"name":"List all users","event":[{"listen":"test","script":{"id":"22c2d647-8f50-4870-9e94-68d4b0b0501d","type":"text/javascript","exec":[""]}}],"id":"f3365249-0d8b-4149-8afe-7e2356a166cb","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://{{workspace}}.igni.co/api/v1/users","description":"

Available filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	int	User ID
email	string	Email of the searched user
nameDisplay	string	Name displayed eg Blanca Ojeda
referralCode	string	User referral code eg ES-M0IX80J7-21
countryId	string	Country code in ISO 3166-1 alpha-2 standard
createdFrom	string	`>=` Date when User was created (`YYYY-MM-DD hh:mm:ss` 24hr format)
createdTo	string	`<=` Date when User was created (`YYYY-MM-DD hh:mm:ss` 24hr format)
active	int	User activity status (1 = true, 0 = false)
activatedFrom	string	`>=` Date when User was activated (`YYYY-MM-DD hh:mm:ss` 24hr format)
activatedTo	string	`<=` Date when User was activated (`YYYY-MM-DD hh:mm:ss` 24hr format)
banned	int	User ban status (1 = true, 0 = false)
bannedFrom	string	`>=` Date when User was activated (`YYYY-MM-DD hh:mm:ss` 24hr format)
bannedTo	string	`<=` Date when User was activated (`YYYY-MM-DD hh:mm:ss` 24hr format)

Available sortings

id
email
nameDisplay
referralCode
countryId
createdAt
active
activatedAt
banned
bannedAt

Required parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
type	string	Always will be `user` value
attributes.email	string	User email
attributes.country	string	Country code in ISO 3166-1 alpha-2 standard

Additional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attributes.active	int	Activate user (`1` = true, `0` = false)
attributes.password	string	User password
attributes.referralCode	string	User's unique Referral code. It needs to be at least 2 characters long and can contain only letters, digits and hyphens.

If you skip active parameter or set it as 0, user will receive an email with activation link.

If you skip password parameter, user will receive an email with the link to set password on his own.

If you skip referralCode parameter, a unique referral code will be generated for user.

Referrer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attributes.referrer.email	string	Email of the referring user
attributes.referrer.referralCode	string	ReferralCode of the referring user eg `PL-D9HC56H9-78`

In the request you can use only one of the above parameters.

If you do not choose the referrer, the user will be assigned to the default referrer.

Account type - Person

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attributes.subject.person.firstName	string	Email of the referring user
attributes.subject.person.firstName	string	ReferralCode of the referring user eg `PL-D9HC56H9-78`

Account type - Company

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attributes.subject.company.name	string	Email of the referring user

Account type - Company with representative person

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attributes.subject.company.name	string	Company name
attributes.subject.company.representativeSubject.firstName	string	Representative person first name
attributes.subject.company.representativeSubject.lastName	string	Representative person last name

If you do not choose the account type, user after logging in will be able to do it on his own.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","users"],"host":["{{workspace}}","igni","co"],"query":[],"variable":[]}},"response":[{"id":"04e74c3b-fe90-485f-a2f1-e18c64e732a4","name":"Create a user with the referrer - Found by referralCode","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"country\": \"US\",\n \"referrer\": {\n \"referrerCode\": \"IS-I8DV62Y8-67\"\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1dc1328a-2d53-46ed-b0c6-4816da438178","name":"Create a user with account type - Person","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"country\": \"US\",\n \"subject\": {\n \"person\": {\n \"firstName\": \"Blanca\",\n \"lastName\": \"Ojeda\"\n }\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"23ce1f63-9311-4fd8-a4aa-7d2272bc1551","name":"The simplest form of user registration","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"country\": \"US\"\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2655aaf3-ebd0-4548-b523-f0724187ca37","name":"Create a user with account type - Company with representative person","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"country\": \"US\",\n \"subject\": {\n \"company\": {\n \t\"name\" : \"Ignico\",\n \t\"representativeSubject\" : {\n \t\"firstName\": \"Blanca\",\n \t\"lastName\": \"Ojeda\"\n \t}\n }\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3cfb52b0-a5dc-4180-ac9c-9e4f2dc2ed45","name":"Create a user with account type - Company","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"country\": \"US\",\n \"subject\": {\n \"company\": {\n \"name\": \"Ignico\"\n }\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4170f155-4ec1-4efd-84fd-52c72ef394b4","name":"Create a user with the password and account type ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"password\": \"FqdX+8dh4KjyHYuR\",\n \"country\": \"US\",\n \"subject\": {\n \"person\": {\n \"firstName\": \"Blanca\",\n \"lastName\": \"Ojeda\"\n }\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"48753661-51b0-42bd-bd27-fb64b8bcaded","name":"Create a user with specified Referral code","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"referralCode\": \"blanca\"\n }\n }\n}\n"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"4e0ab951-8d44-478f-a5c0-c9019084f26e","name":"Create a user with the referrer - Found by email","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"country\": \"US\",\n \"referrer\": {\n \"email\": \"referrer@example.net\"\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"69ebf1b4-8f67-4159-b38f-9972b33818ab","name":"Create a user with password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"password\": \"FqdX+8dh4KjyHYuR\",\n \"country\": \"US\"\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"87c8e73b-c56d-41f5-a3cc-a0168cede92b","name":"Create a user with the referrer and account type ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"country\": \"US\",\n \"subject\": {\n \"person\": {\n \"firstName\": \"Blanca\",\n \"lastName\": \"Ojeda\"\n }\n },\n \"referrer\": {\n \"email\": \"madelene.nyberg@example.com\"\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"98507704-35ea-43d9-9d1e-a509807193c3","name":"Create a user with the referrer, password and account type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"password\": \"FqdX+8dh4KjyHYuR\",\n \"country\": \"US\",\n \"subject\": {\n \"person\": {\n \"firstName\": \"Blanca\",\n \"lastName\": \"Ojeda\"\n }\n },\n \"referrer\": {\n \"email\": \"madelene.nyberg@example.com\"\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ddd504de-52aa-48a7-af84-87c6314d3a00","name":"Create a user with the referrer and password","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"email\": \"blanca.ojeda@example.net\",\n \"password\": \"FqdX+8dh4KjyHYuR\",\n \"country\": \"US\",\n \"referrer\": {\n \"email\": \"madelene.nyberg@example.com\"\n }\n }\n }\n}"},"url":"https://{{workspace}}.igni.co/api/v1/users"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5f14e2a0-5e6f-4de0-8fea-00774c78c9c1"}],"id":"d7596372-c727-4cb9-ab1f-2d35c97fa36f","_postman_id":"d7596372-c727-4cb9-ab1f-2d35c97fa36f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}}},{"name":"Wallets","item":[{"name":"List all user wallets","event":[{"listen":"test","script":{"id":"22c2d647-8f50-4870-9e94-68d4b0b0501d","type":"text/javascript","exec":[""]}}],"id":"bba73d93-aa7f-4539-ab7b-df831343bd98","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":""},"url":"https://{{workspace}}.igni.co/api/v1/users/wallets","description":"

Available filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	int	Transaction ID
currency	string	Wallet currency e.g. `EUR`
balanceCurrentGreaterEqual	string	Available funds in the wallet are greater or equal than e.g. `14.50`
balanceCurrentLessEqual	string	Available funds in the wallet are less or equal than e.g. `14.50`
balanceAccountingGreaterEqual	string	Wallet balance is greater or equal than e.g. `24.70`
balanceAccountingLessEqual	string	Wallet balance is less or equal than e.g. `24.70`

Available sortings

id
currency
balanceCurrent
balanceAccounting

Available filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
id	int	Transaction ID
cancelled	int	Transaction cancel status (`1` = true, `0` = false)
realized	int	Transaction realize status (`1` = true, `0` = false)
type	int	Can be `add`, `sub` or `period`
currency	string	Original transaction currency e.g. `EUR`
amount	string	Original transaction value e.g. `14.50` (before conversion `EUR` to `USD`)
addedAtGreaterEqual	string	`>=` Date when Transaction was added (`YYYY-MM-DD hh:mm:ss` 24hr format)
addedAtLessEqual	string	`<=` Date when Transaction was added (`YYYY-MM-DD hh:mm:ss` 24hr format)

Available sortings

id
cancelled
realized
type
currency
amount
addedAt

Request parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
type	string	`transaction`
attributes.user.email	string	Email of a user that will be the owner of the transaction
attributes.type	string	Can be `add` or `sub`
attributes.amount	mixed	Transaction amount e.g `16.65`
attributes.description	string	Transaction description

Additional parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
realized	int	If the value is `1` the transaction will be automatically marked as realized

You can define the transaction owner also via referral Code

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
attributes.user.referralCode	string	Referral code of a user that will be the owner of the transaction

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","users","wallets","transactions"],"host":["{{workspace}}","igni","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"546656ec-6032-4af1-965f-9d9d5a77eda3"},{"name":"Realize the wallet transaction","event":[{"listen":"test","script":{"id":"22c2d647-8f50-4870-9e94-68d4b0b0501d","type":"text/javascript","exec":[""]}}],"id":"189050b5-2a9f-4863-8679-ce5cb5be9e9b","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"transaction\",\n \"attributes\": {\n \"realized\": true\n }\n }\n}\n"},"url":"https://{{workspace}}.igni.co/api/v1/users/wallets/transactions/{{transaction_id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","users","wallets","transactions","{{transaction_id}}"],"host":["{{workspace}}","igni","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"189050b5-2a9f-4863-8679-ce5cb5be9e9b"},{"name":"Cancel the wallet transaction","event":[{"listen":"test","script":{"id":"22c2d647-8f50-4870-9e94-68d4b0b0501d","type":"text/javascript","exec":[""]}}],"id":"d1229c1a-b1c3-48f5-8260-d9b5ad2b9f22","request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"transaction\",\n \"attributes\": {\n \"cancelled\": true\n }\n }\n}\n"},"url":"https://{{workspace}}.igni.co/api/v1/users/wallets/transactions/{{transaction_id}}","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}},"urlObject":{"protocol":"https","path":["api","v1","users","wallets","transactions","{{transaction_id}}"],"host":["{{workspace}}","igni","co"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1229c1a-b1c3-48f5-8260-d9b5ad2b9f22"}],"id":"a5530d69-bf7b-48e0-aa5d-356f7934b208","_postman_id":"a5530d69-bf7b-48e0-aa5d-356f7934b208","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","name":"Resources","type":"folder"}}}],"id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2","description":"

Manage or view your instance resources.

All endpoints require Bearer access token.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"8ac39e35-5bcc-464a-b274-01ab154212b7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab4d2ca8-7cb8-42fe-8e36-393d900cf6ab","type":"text/javascript","exec":[""]}}],"_postman_id":"fea5059a-fdc5-4081-a04c-42f45f0fcac2"}],"event":[{"listen":"prerequest","script":{"id":"7f6cacbd-5cc5-4197-9288-d10c9cf44b63","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fbaad507-45ec-4ae9-b086-aa2d71970b0d","type":"text/javascript","exec":[""]}}]}