inChurch
inChurch API

Group Segmentation

Endpoint:https://inradar.com.br/public

List Segmentation Groups

GET
https://inradar.com.br/public
/v1/group/

Get a list of segmentation groups based on the user's access level.

List Segmentation Groups › query Parameters

  • limitinteger

    Number of results to return per page.

  • offsetinteger

    The initial index from which to return the results.

List Segmentation Groups › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

List Segmentation Groups › Responses

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

List Group Memberships

GET
https://inradar.com.br/public
/v1/group/{parent_lookup_small_group_id}/memberships/

Get a list of memberships for a specific segmentation group.

List Group Memberships › path Parameters

  • parent_lookup_small_group_idstring · required

List Group Memberships › query Parameters

  • limitinteger

    Number of results to return per page.

  • offsetinteger

    The initial index from which to return the results.

List Group Memberships › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

List Group Memberships › Responses

  • countinteger · required
    Example: 123
  • resultsobject[] · required
  • nextstring | null · uri
    Example: http://api.example.org/accounts/?offset=400&limit=100
  • previousstring | null · uri
    Example: http://api.example.org/accounts/?offset=200&limit=100

Create a Group Membership

POST
https://inradar.com.br/public
/v1/group/{parent_lookup_small_group_id}/memberships/

Create a new membership for a specific segmentation group.

Create a Group Membership › path Parameters

  • parent_lookup_small_group_idstring · required

Create a Group Membership › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

  • Content-Typestring · enum · required
    Enum values:
    application/json

Create a Group Membership › Request Body

  • personinteger

    ID of the member to add to the group.

  • is_approvedboolean
    Default: true

Create a Group Membership › Responses

  • idinteger · readOnly · required
  • personinteger · required
  • group_idinteger · readOnly · required
  • is_approvedboolean · required
  • approval_datestring · date-time · readOnly · required
  • joined_atstring · date-time · readOnly · required

Segmentation Groups Detail

GET
https://inradar.com.br/public
/v1/group/{id}/

Get detail of a segmentation group

Segmentation Groups Detail › path Parameters

  • idinteger · required

    A unique integer value identifying this small group.

Segmentation Groups Detail › Headers

  • Authorizationstring · required

    HTTP Basic. SEND: Basic base64(api_key:api_secret)

Segmentation Groups Detail › Responses

  • idinteger · readOnly · required
  • namestring · maxLength: 200 · required
Financial - SuppliersPeople