Post v2contacts

Retrieve some public contact. Normal users can only search specific email/ids

POST /v2/contacts

cURL

cURL

curl --request POST \
  --url https://api.eda.prisme.ai/v2/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "text": "<string>",
  "ids": [
    "<string>"
  ],
  "firstName": "<string>",
  "lastName": "<string>",
  "authProvider": "<string>",
  "platformRole": "<string>",
  "groups": [
    "<string>"
  ],
  "includeOrgMembership": "<string>"
}
'

import requests

url = "https://api.eda.prisme.ai/v2/contacts"

payload = {
    "email": "<string>",
    "text": "<string>",
    "ids": ["<string>"],
    "firstName": "<string>",
    "lastName": "<string>",
    "authProvider": "<string>",
    "platformRole": "<string>",
    "groups": ["<string>"],
    "includeOrgMembership": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '<string>',
    text: '<string>',
    ids: ['<string>'],
    firstName: '<string>',
    lastName: '<string>',
    authProvider: '<string>',
    platformRole: '<string>',
    groups: ['<string>'],
    includeOrgMembership: '<string>'
  })
};

fetch('https://api.eda.prisme.ai/v2/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eda.prisme.ai/v2/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => '<string>',
    'text' => '<string>',
    'ids' => [
        '<string>'
    ],
    'firstName' => '<string>',
    'lastName' => '<string>',
    'authProvider' => '<string>',
    'platformRole' => '<string>',
    'groups' => [
        '<string>'
    ],
    'includeOrgMembership' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eda.prisme.ai/v2/contacts"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"text\": \"<string>\",\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"authProvider\": \"<string>\",\n  \"platformRole\": \"<string>\",\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"includeOrgMembership\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.eda.prisme.ai/v2/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"text\": \"<string>\",\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"authProvider\": \"<string>\",\n  \"platformRole\": \"<string>\",\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"includeOrgMembership\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eda.prisme.ai/v2/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"<string>\",\n  \"text\": \"<string>\",\n  \"ids\": [\n    \"<string>\"\n  ],\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"authProvider\": \"<string>\",\n  \"platformRole\": \"<string>\",\n  \"groups\": [\n    \"<string>\"\n  ],\n  \"includeOrgMembership\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "contacts": [
    {
      "firstName": "<string>",
      "lastName": "<string>",
      "language": "<string>",
      "photo": "<string>",
      "meta": {},
      "groups": [
        "<string>"
      ],
      "membership": {
        "roleSlug": "<string>",
        "joinedAt": "<string>",
        "invitedAt": "<string>",
        "invitedBy": "<string>"
      },
      "id": "<string>"
    }
  ],
  "size": 123
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page · number

Page number

limit · number

Page size

createdBefore · string

User signed up before that date (ISO8601), reserved to super admins

createdAfter · string

User signed up before that date (ISO8601), reserved to super admins

orgSlug · string

Filter users by organization slug, reserved to super admins / root

Body

application/json

email · string

text · string

Search in both email & id

ids · string[]

firstName · string

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

lastName · string

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

authProvider · string

status · enum<string>

Available options: pending, validated, deactivated

platformRole · string

groups · string[]

includeOrgMembership · string

Org slug — enrich contacts with membership data from this org (requires super admin or org admin permissions)

Response

200

application/json

Success Response

contacts · object[] · required

Show child attributes

size · number

Total number of matching contacts