Home

This document is a work in progress and your opinion helps us to improve. Please let us know what we can do better. Thanks! support@procurios.com

CRM

The CRM API exposes relation data. The fields are dynamically configured. The exposed data may differ between contexts, as does the set of relations. You can request the set of relation data by using the context id. The methods below use the example value of 42.

Accept header for requests to CRM

application/vnd.procurios.relation+json; version=1

contexts GET

URL: /l/milieudefensie_blendr/crm/contexts

Scope:

Last used: September 22, 2023 13:51

Get the contexts available to your access token.

Live testing disabled

contexts

Request

json

Response

jsonStatus: 200
{
    "contexts": [
        {
            "id": 1,
            "title": "testLijst",
            "_links": {
                "relations": {
                    "href": "\/l\/milieudefensie_blendr\/crm\/1\/relation",
                    "type": "GET"
                },
                "schema": {
                    "href": "\/l\/milieudefensie_blendr\/crm\/1\/schema",
                    "type": "GET"
                }
            }
        }
    ]
}

schema GET

URL: /l/milieudefensie_blendr/crm/42/schema

Scope:

Last used: July 24, 2023 09:19

Get the schema for the relation data.

Live testing disabled

schema

Request

json

Response

jsonStatus: 200
{
    "schema": "http:\/\/json-schema.org\/draft-07\/schema#",
    "title": "testLijst",
    "type": "object",
    "properties": {
        "kiwiName": {
            "title": "Volledige naam"
        },
        "address-0": {
            "title": "Standaardadres"
        },
        "phoneAll": {
            "title": "Telefoonnummers"
        },
        "kiwiCreated": {
            "title": "Aangemaakt op"
        },
        "emailPrimary": {
            "title": "Primair e-mailadres"
        }
    }
}

relation data GET

URL: /l/milieudefensie_blendr/crm/42/relation

Scope:

Last used: September 19, 2024 17:45

Get the relation data that is applicable to the context.

Parameters

Parameter Type Description
page int

The api will provide 25 results per page
since datetime

Only get results created or updated since yyyy-mm-ddThh:mm:ss
Live testing disabled

relation data

Request

json

Response

jsonStatus: 200
{
    "fieldTitles": {
        "kiwiName": "Volledige naam",
        "address-0": "Standaardadres",
        "phoneAll": "Telefoonnummers",
        "kiwiCreated": "Aangemaakt op",
        "freeField-653044": "Programma: welkom - waardering - winback"
    },
    "relations": [
        {
            "relationId": 643849,
            "kiwiName": "Rocurios, P. (Piet)",
            "address-0": "",
            "phoneAll": "",
            "kiwiCreated": "23-12-19 08:48:18",
            "freeField-653044": "T - T - T"
        },
        {
            "relationId": 646536,
            "kiwiName": "Ocurios, P. R. (Ria)",
            "address-0": "Hoefzijde 3\n3961 MX  WIJK BIJ DUURSTEDE",
            "phoneAll": "(T) 0123456789",
            "kiwiCreated": "24-03-20 09:10:07",
            "freeField-653044": "T - C - C"
        }
    ]
}

selections for relation GET

URL: /l/milieudefensie_blendr/crm/42/relation/887/selection

Scope:

Last used: Never

Get the selections for a relation.

Live testing disabled

selections for relation

Request

json

Response

jsonStatus: 200
{
    "selections": [
        {
            "id": 6,
            "title": "Selectie nummer 6"
        },
        {
            "id": 8,
            "title": "Selectie nummer 8"
        }
    ]
}