Additional Fields Resource

Routes

name method path description
Get additional fields GET /api/v1/additional_fields Retrieve all or some additional fields of your community.
Add additional field POST /api/v1/additional_fields Add an additional field to your community. Currently, these fields are only available to members.
Delete additional field DELETE /api/v1/additional_fields/{identifier} Delete the additonal field based on their identifier.
Get additional field GET /api/v1/additional_fields/{identifier} Return a specific additional field. To do this, you need the id provided by Socie.
Update additional field PATCH /api/v1/additional_fields/{identifier} Update the information for a single addtional field.

Get additional fields

GET /api/v1/additional_fields

Retrieve all or some additional fields of your community.

Request Parameters
name type description
X-API-Key header The API Key for your community.
limit query Use this parameter to limit the amount of objects returned. Check Pagination for more information.
skip query Use this parameter to skip some objects in the response. Check Pagination for more information.
sort query Use this parameter to sort the response on 1 of the fields listed under 'Possible Sort Fields'. Check Sorting for more information.
Possible Sort Fields
createdAt  modifiedAt  orderNumber 
Response Body
media type data type description
application/json ApiAdditionalFieldsResponse (JSON)

Example

Request
GET /api/v1/additional_fields
Content-Type: */*
Accept: application/json
X-API-Key: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "results" : [ {
    "id" : "5bBePJwK9ycB1QnjOlot",
    "name" : "Company name",
    "placeholder" : "Your company name",
    "type" : "TEXT",
    "icon" : {
      "style" : "REGULAR",
      "unicode" : "f34e"
    },
    "isEditableByMember" : true,
    "isMandatoryForMember" : false,
    "isVisibleInApp" : false,
    "orderNumber" : 0,
    "createdAt" : "2021-04-23T18:25:43.511Z",
    "modifiedAt" : "2021-04-23T18:25:43.511Z"
  }, {
    "id" : "...",
    "name" : "...",
    "placeholder" : "...",
    "type" : "...",
    "icon" : {
      "style" : "...",
      "unicode" : "..."
    },
    "isEditableByMember" : true,
    "isMandatoryForMember" : true,
    "isVisibleInApp" : true,
    "orderNumber" : 12345,
    "createdAt" : "...",
    "modifiedAt" : "..."
  } ],
  "_links" : {
    "base" : "https://api.socie.nl",
    "next" : "/api/v1/members?skip=5&limit=5",
    "prev" : "/api/v1/members?skip=0&limit=5",
    "self" : "https://api.socie.nl/api/v1/members"
  },
  "limit" : 5,
  "skip" : 10,
  "size" : 1
}
Add additional field

POST /api/v1/additional_fields

Add an additional field to your community. Currently, these fields are only available to members.

Request Parameters
name type description
X-API-Key header The API Key for your community.
Request Body
media type data type
application/json ApiAdditionalFieldInput (JSON)
Response Body
media type data type description
application/json ApiInsertResponse (JSON)

Example

Request
POST /api/v1/additional_fields
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "name" : "Company name",
  "placeholder" : "Your company name",
  "type" : "TEXT",
  "icon" : {
    "style" : "REGULAR",
    "unicode" : "f34e"
  },
  "isEditableByMember" : true,
  "isMandatoryForMember" : true,
  "isVisibleInApp" : true,
  "orderNumber" : 0
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "id" : "5bBePJwK9ycB1QnjOlot",
  "externalId" : "123456"
}
Delete additional field

DELETE /api/v1/additional_fields/{identifier}

Delete the additonal field based on their identifier.

Request Parameters
name type description
X-API-Key header The API Key for your community.
identifier path The id of the additional field you would like to delete.

Example

Request
DELETE /api/v1/additional_fields/{identifier}
Content-Type: */*
X-API-Key: ...

                
...
Response
HTTP/1.1 204 No Content
Get additional field

GET /api/v1/additional_fields/{identifier}

Return a specific additional field. To do this, you need the id provided by Socie.

Request Parameters
name type description
X-API-Key header The API Key for your community.
identifier path The id of the additional field you would like to retrieve.
Response Body
media type data type description
application/json ApiAdditionalFieldResponse (JSON)

Example

Request
GET /api/v1/additional_fields/{identifier}
Content-Type: */*
Accept: application/json
X-API-Key: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : "5bBePJwK9ycB1QnjOlot",
  "name" : "Company name",
  "placeholder" : "Your company name",
  "type" : "TEXT",
  "icon" : {
    "style" : "REGULAR",
    "unicode" : "f34e"
  },
  "isEditableByMember" : true,
  "isMandatoryForMember" : false,
  "isVisibleInApp" : false,
  "orderNumber" : 0,
  "createdAt" : "2021-04-23T18:25:43.511Z",
  "modifiedAt" : "2021-04-23T18:25:43.511Z"
}
Update additional field

PATCH /api/v1/additional_fields/{identifier}

Update the information for a single addtional field.

Request Parameters
name type description
X-API-Key header The API Key for your community.
identifier path The id of the additional field you would like to update.
Request Body
media type data type
application/json ApiAdditionalFieldPatchInput (JSON)
Response Codes
code condition
204 The additonal field was updated successfully
Response Body
media type data type description
application/json NoContentResponse (JSON)

Example

Request
PATCH /api/v1/additional_fields/{identifier}
Content-Type: application/json
Accept: application/json
X-API-Key: ...

                
{
  "name" : "Company name",
  "placeholder" : "Your company name",
  "icon" : {
    "style" : "REGULAR",
    "unicode" : "f34e"
  },
  "isEditableByMember" : true,
  "isMandatoryForMember" : true,
  "isVisibleInApp" : true,
  "orderNumber" : 0
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }