getProfileListByName

GET /api/customer/profile/{type}

getProfileListByName

cURL

curl --request GET \
  --url https://api.artemis.cynopsis.co/api/customer/profile/{type} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'

import requests

url = "https://api.artemis.cynopsis.co/api/customer/profile/{type}"

headers = {
    "X-Domain-ID": "<x-domain-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Domain-ID': '<x-domain-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.artemis.cynopsis.co/api/customer/profile/{type}', 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.artemis.cynopsis.co/api/customer/profile/{type}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Domain-ID: <x-domain-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.artemis.cynopsis.co/api/customer/profile/{type}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Domain-ID", "<x-domain-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.artemis.cynopsis.co/api/customer/profile/{type}")
  .header("X-Domain-ID", "<x-domain-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/customer/profile/{type}")

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

request = Net::HTTP::Get.new(url)
request["X-Domain-ID"] = '<x-domain-id>'
request["Authorization"] = 'Bearer <token>'

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

200

{
  "content": [
    {
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "customers": [
        {
          "active": true,
          "batchUpload": {
            "createdAt": {
              "date": 123,
              "day": 123,
              "hours": 123,
              "minutes": 123,
              "month": 123,
              "nanos": 123,
              "seconds": 123,
              "time": 123,
              "timezoneOffset": 123,
              "year": 123
            },
            "createdBy": {
              "email": "<string>",
              "firstName": "<string>",
              "fullName": "<string>",
              "id": 123,
              "lastName": "<string>"
            },
            "domainId": 123,
            "failReasons": "<string>",
            "filePath": "<string>",
            "filename": "<string>",
            "id": 123,
            "runtime": "2023-11-07T05:31:56Z",
            "updatedAt": {
              "date": 123,
              "day": 123,
              "hours": 123,
              "minutes": 123,
              "month": 123,
              "nanos": 123,
              "seconds": 123,
              "time": 123,
              "timezoneOffset": 123,
              "year": 123
            },
            "updatedBy": {
              "email": "<string>",
              "firstName": "<string>",
              "fullName": "<string>",
              "id": 123,
              "lastName": "<string>"
            }
          },
          "batchUploadId": 123,
          "createdAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          },
          "crpList": "<array>",
          "crpRoles": [
            {
              "appointedDate": "2023-12-25",
              "createdAt": {
                "date": 123,
                "day": 123,
                "hours": 123,
                "minutes": 123,
                "month": 123,
                "nanos": 123,
                "seconds": 123,
                "time": 123,
                "timezoneOffset": 123,
                "year": 123
              },
              "createdBy": {
                "email": "<string>",
                "firstName": "<string>",
                "fullName": "<string>",
                "id": 123,
                "lastName": "<string>"
              },
              "id": 123,
              "resignedDate": "2023-12-25",
              "role": "<string>",
              "updatedAt": {
                "date": 123,
                "day": 123,
                "hours": 123,
                "minutes": 123,
                "month": 123,
                "nanos": 123,
                "seconds": 123,
                "time": 123,
                "timezoneOffset": 123,
                "year": 123
              },
              "updatedBy": {
                "email": "<string>",
                "firstName": "<string>",
                "fullName": "<string>",
                "id": 123,
                "lastName": "<string>"
              }
            }
          ],
          "domainId": 123,
          "fields": {},
          "forms": {},
          "id": 123,
          "notes": {},
          "profile": "<unknown>",
          "referenceId": "<string>",
          "updatedAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          },
          "vendorName": "<string>",
          "vendorProfileEntityGuid": "<string>"
        }
      ],
      "documents": [
        {
          "authenticity": "<string>",
          "back": "<string>",
          "backName": "<string>",
          "createdAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          },
          "expiryDate": "2023-12-25",
          "front": "<string>",
          "frontName": "<string>",
          "id": 123,
          "issueDate": "2023-12-25",
          "number": "<string>",
          "showExpiryNotification": true,
          "type": "<string>",
          "updatedAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          }
        }
      ],
      "fields": {},
      "id": 123,
      "profileReferenceId": "<string>",
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID · integer<int64> · required

X-Domain-ID

Path Parameters

type · enum<string> · required

type

Available options: CORPORATE, INDIVIDUAL

Query Parameters

offset · integer<int64>

paged · boolean

pageNumber · integer<int32>

pageSize · integer<int32>

searchString · string

searchString

sort.sorted · boolean

sort.unsorted · boolean

unpaged · boolean

Response

200

*/*

OK

content · Profile · object[]

Show child attributes

empty · boolean

first · boolean

last · boolean

number · integer<int32>

numberOfElements · integer<int32>

pageable · Pageable · object

Show child attributes

size · integer<int32>

sort · Sort · object

Show child attributes

totalElements · integer<int64>

totalPages · integer<int32>