View

GET

http://localhost:8000/api/surrogates/:id

GET

/api/surrogates/:id

1 curl http://localhost:8000/api/surrogates/19 \
2      -H "Authorization: Bearer <token>"

200Surrogate_View_example

1 {
2   "hasActiveSubscription": true,
3   "user": {
4     "id": 18,
5     "agency_id": 1,
6     "full_name": "Agency Surroagate",
7     "first_name": "Agency",
8     "last_name": "Surroagate",
9     "email": "agency.surrogate@gmail.com",
10     "unique_id": "S-0001",
11     "is_premium": false,
12     "ip_whitelist_enabled": false,
13     "is_editable": "yes",
14     "profile_percentage": 5,
15     "profile_picture": "http://localhost:8000/assets/ivf-img/profile/user-placeholder/surrogate.jpg",
16     "banner_image": "http://localhost:8000/assets/ivf-img/profile/user-placeholder/surrogate.jpg",
17     "status_id": 3,
18     "status": {
19       "id": 3,
20       "name": "pending_profile",
21       "class": "warning",
22       "type": "user",
23       "translated_name": "Pending Profile"
24     },
25     "is_private_donor": "no",
26     "has_contact_details": "yes",
27     "is_required_edit_approval": true,
28     "role": "surrogate"
29   },
30   "user_profile": {
31     "user_id": 18,
32     "mobile_phone": "21123456",
33     "mobile_phone_country": "US",
34     "home_phone": "1234567890",
35     "home_phone_country": "US",
36     "formated_height": "-",
37     "formated_weight": "-"
38   },
39   "agency": {
40     "id": 1,
41     "name": "Agency 1",
42     "email": "agency@gmail.com",
43     "mobile_phone": "+11234567890",
44     "mobile_phone_country": "US",
45     "is_required_edit_approval": true,
46     "is_bypass_donor_verification": false
47   },
48   "address": {},
49   "profile_steps": {
50     "tab_status": {
51       "general-characteristics": {
52         "completed": false,
53         "locked": false
54       },
55       "demographics": {
56         "completed": false,
57         "locked": true
58       },
59       "photos-videos": {
60         "completed": false,
61         "locked": true
62       },
63       "pregnancy-history": {
64         "completed": false,
65         "locked": true
66       },
67       "questionnaire-4": {
68         "completed": false,
69         "locked": true,
70         "progress": {
71           "total": 1,
72           "completed": 0,
73           "percentage": 0,
74           "subcategories": [
75             {
76               "id": 18,
77               "title": "Pregnancy and Health History",
78               "key": "surrogate_pregnancy_and_health_history",
79               "completed": false,
80               "locked": false
81             }
82           ]
83         },
84         "category_id": 4,
85         "category_title": "Pregnancy and Health History"
86       },
87       "questionnaire-5": {
88         "completed": false,
89         "locked": true,
90         "progress": {
91           "total": 1,
92           "completed": 0,
93           "percentage": 0,
94           "subcategories": [
95             {
96               "id": 19,
97               "title": "Lifestyle and Daily Routines",
98               "key": "surrogate_lifestyle_and_daily_routines",
99               "completed": false,
100               "locked": false
101             }
102           ]
103         },
104         "category_id": 5,
105         "category_title": "Lifestyle and Daily Routines"
106       },
107       "questionnaire-6": {
108         "completed": false,
109         "locked": true,
110         "progress": {
111           "total": 1,
112           "completed": 0,
113           "percentage": 0,
114           "subcategories": [
115             {
116               "id": 20,
117               "title": "Medical and Health Screening",
118               "key": "surrogate_medical_and_health_screening",
119               "completed": false,
120               "locked": false
121             }
122           ]
123         },
124         "category_id": 6,
125         "category_title": "Medical and Health Screening"
126       },
127       "questionnaire-7": {
128         "completed": false,
129         "locked": true,
130         "progress": {
131           "total": 1,
132           "completed": 0,
133           "percentage": 0,
134           "subcategories": [
135             {
136               "id": 21,
137               "title": "Emotional Readiness and Expectations",
138               "key": "surrogate_emotional_readiness_and_expectations",
139               "completed": false,
140               "locked": false
141             }
142           ]
143         },
144         "category_id": 7,
145         "category_title": "Emotional Readiness and Expectations"
146       },
147       "questionnaire-8": {
148         "completed": false,
149         "locked": true,
150         "progress": {
151           "total": 1,
152           "completed": 0,
153           "percentage": 0,
154           "subcategories": [
155             {
156               "id": 22,
157               "title": "Employment-Related Questions with Answer Hints",
158               "key": "surrogate_employment-related_questions_with_answer_hints",
159               "completed": false,
160               "locked": false
161             }
162           ]
163         },
164         "category_id": 8,
165         "category_title": "Employment-Related Questions with Answer Hints"
166       }
167     },
168     "completed_tabs": []
169   },
170   "admin_profile_steps": {
171     "groups": {
172       "account-profile": {
173         "total": 4,
174         "completed": 0,
175         "percentage": 0,
176         "tabs": {
177           "general-characteristics": {
178             "completed": false,
179             "locked": false
180           },
181           "demographics": {
182             "completed": false,
183             "locked": true
184           },
185           "photos-videos": {
186             "completed": false,
187             "locked": true
188           },
189           "pregnancy-history": {
190             "completed": false,
191             "locked": true
192           }
193         }
194       },
195       "questionnaire": {
196         "total": 5,
197         "completed": 0,
198         "percentage": 0,
199         "tabs": {
200           "questionnaire-4": {
201             "completed": false,
202             "locked": true,
203             "progress": {
204               "total": 1,
205               "completed": 0,
206               "percentage": 0,
207               "subcategories": [
208                 {
209                   "id": 18,
210                   "title": "Pregnancy and Health History",
211                   "key": "surrogate_pregnancy_and_health_history",
212                   "completed": false,
213                   "locked": false
214                 }
215               ]
216             },
217             "category_id": 4,
218             "category_title": "Pregnancy and Health History"
219           },
220           "questionnaire-5": {
221             "completed": false,
222             "locked": true,
223             "progress": {
224               "total": 1,
225               "completed": 0,
226               "percentage": 0,
227               "subcategories": [
228                 {
229                   "id": 19,
230                   "title": "Lifestyle and Daily Routines",
231                   "key": "surrogate_lifestyle_and_daily_routines",
232                   "completed": false,
233                   "locked": false
234                 }
235               ]
236             },
237             "category_id": 5,
238             "category_title": "Lifestyle and Daily Routines"
239           },
240           "questionnaire-6": {
241             "completed": false,
242             "locked": true,
243             "progress": {
244               "total": 1,
245               "completed": 0,
246               "percentage": 0,
247               "subcategories": [
248                 {
249                   "id": 20,
250                   "title": "Medical and Health Screening",
251                   "key": "surrogate_medical_and_health_screening",
252                   "completed": false,
253                   "locked": false
254                 }
255               ]
256             },
257             "category_id": 6,
258             "category_title": "Medical and Health Screening"
259           },
260           "questionnaire-7": {
261             "completed": false,
262             "locked": true,
263             "progress": {
264               "total": 1,
265               "completed": 0,
266               "percentage": 0,
267               "subcategories": [
268                 {
269                   "id": 21,
270                   "title": "Emotional Readiness and Expectations",
271                   "key": "surrogate_emotional_readiness_and_expectations",
272                   "completed": false,
273                   "locked": false
274                 }
275               ]
276             },
277             "category_id": 7,
278             "category_title": "Emotional Readiness and Expectations"
279           },
280           "questionnaire-8": {
281             "completed": false,
282             "locked": true,
283             "progress": {
284               "total": 1,
285               "completed": 0,
286               "percentage": 0,
287               "subcategories": [
288                 {
289                   "id": 22,
290                   "title": "Employment-Related Questions with Answer Hints",
291                   "key": "surrogate_employment-related_questions_with_answer_hints",
292                   "completed": false,
293                   "locked": false
294                 }
295               ]
296             },
297             "category_id": 8,
298             "category_title": "Employment-Related Questions with Answer Hints"
299           }
300         }
301       }
302     },
303     "completed_tabs": []
304   },
305   "consent": [],
306   "expertises": [],
307   "languages": [],
308   "speciality_services": []
309 }

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response headers

Hoststring

X-Powered-Bystring

Cache-Controlstring

X-RateLimit-Limitstring

X-RateLimit-Remainingstring

Access-Control-Allow-Originstring

Response

hasActiveSubscriptionboolean

userobject

user_profileobject

agencyobject

addressobject

profile_stepsobject

admin_profile_stepsobject

expertiseslist of any

languageslist of any

speciality_serviceslist of any

recruiterany

clinicany